nodewikiaapi

Global

Type Definitions

ArticleDetailsReq

Type

  • Object

Properties

  • ids number | Array.<number> <optional>

    An array of article ids or a single article id

  • titles string | Array.<string> <optional>

    An array of article titles or a single article title, can be used alongside ids

  • abstract number <optional>
     100

    The desired length for the article's abstract

See

Source

ArticleDetailsResItem

Type

  • Object

Properties

  • id number

    Internal article identifier

  • title string

    Article's title

  • ns number

    Article's namespace, see: see: Help:Namespaces

  • url string

    Article's URL

  • revision ArticleDetailsResItemRevision

    Last revision of the article

  • type string

    Type of the page ("article" for articles)

  • abstract string

    Short description of the article

Source

ArticleDetailsResItemRevision

Type

  • Object

Properties

  • id number

    Internal revision identifier

  • user string

    Username of associated editor

  • user_id number

    Identifier of associated editor

  • timestamp string

    Time of the revision

Source

ArticleItem

Type

  • Object

Properties

  • id number

    Internal article identifier

  • title string

    Article's title

  • url string

    Article's URL

  • ns number

    Article's namespace, see: see: Help:Namespaces

Source

ArticleListReq

Type

  • Object

Properties

  • category string <optional>

    Return only articles belonging to the provided valid category title

  • namespaces number | Array.<number> <optional>

    Array of namespace ids or a single namespace id, see: Help:Namespaces

  • limit number <optional>
     25

    Limit the number of results

  • offset string <optional>

    Only display articles where name is lexicographically greater than provided

See

Source

ArticleListRes

Type

  • Object

Properties

  • items Array.<ArticleItem>

    Array of article items

  • basepath string

    URL of associated wiki

  • offset string

    Current lexicographical offset (lists first articles where titles are greater lexicographically than that offset)

See

Source

SearchSuggestionsResItem

Type

  • Object

Properties

  • title string

    Suggested article's title

Source

TopArticlesReq

Type

  • Object

Properties

  • namespaces number | Array.<number> <optional>

    Array of namespace ids or a single namespace id, see: Help:Namespaces

  • category string <optional>

    Return only articles belonging to the provided category title

  • limit number <optional>
     10

    Limit the number of results - maximum limit is 250

See

Source

UserDetailsReq

Type

  • Object

Properties

  • ids number | Array.<number>

    An array of user ids or a single user id

  • size number <optional>
     100

    The desired width and height of the thumbnail, defaults to 100, 0 for no thumbnail

See

Source

UserDetailsResItem

Type

  • Object

Properties

  • user_id number

    Internal user identifier

  • title string

    User's title

  • name string

    User's name

  • url string

    URL of user's profile page

  • numberofedits number

    Number of user's edits on the given wiki

  • is_subject_to_ccpa boolean

    See: CCPA

  • avatar string

    Link to user's avatar

Source

WikiVariablesResAppleIcon

Type

  • Object

Properties

  • url string

    Icon's URL

  • size string

    String describing icon's dimensions

Source

WikiVariablesResData

Type

  • Object

Properties

  • vertical string

    Primary category of the wiki

  • appleTouchIcon WikiVariablesResAppleIcon

    Object describing icon shown on Apple devices

  • articlePath string

    Base URL of wiki's articles

  • basePath string

    Base URL of the entire site

  • dbName string

    Name of related database

  • favicon string

    URL of site's favicon, see Help:Favicon

  • id number

    Internal wiki identifier

  • isClosed boolean

    Whether the wiki is closed

  • htmlTitle WikiVariablesResHtmlTitle

    Object describing how wiki's <title> tag is formed

  • language WikiVariablesResLanguage

    Object describing wiki's language

  • scriptPath string

    Base URL of site's JS scripts

  • siteName string

    Main title of the wiki in its full form

  • surrogateKey string

    Wiki's identifier in internal databases

  • enableCommunityData boolean
  • mainPageTitle string

    Title of wiki's home/landing article

  • siteMessage string

    Full wiki title

  • cookieDomain string

    Scope of cookies stored on this wiki

Source

WikiVariablesResHtmlTitle

Type

  • Object

Properties

  • separator string

    Title separator sequence

  • parts Array.<string>

    Parts of the title

Source

WikiVariablesResLanguage

Type

  • Object

Properties

  • content string

    Wiki's content language

  • contentDir "ltr" | "rtl"

    Direction of text ("ltr" - left to right, "rtl" - right to left)

Source