iwf
    Preparing search index...

    Class Description

    Class for descriptions.

    Index

    Constructors

    constructor

    Properties

    language value

    Accessors

    internalID

    Methods

    equals toJSON fromString

    Constructors

    • Constructor for the Description class.

      Parameters

      • label: LabelAndDescription

        The label in JSON format.

      Returns Description

      const description = new Description({ language: 'en', value: 'Douglas Adams' });

    Properties

    language:
        | "aa"
        | "aae"
        | "ab"
        | "abs"
        | "ace"
        | "acf"
        | "acm"
        | "ady"
        | "ady-cyrl"
        | "aeb"
        | "aeb-arab"
        | "aeb-latn"
        | "af"
        | "agq"
        | "ak"
        | "aln"
        | "als"
        | "alt"
        | "am"
        | "ami"
        | "an"
        | "ang"
        | "ann"
        | "anp"
        | "apc"
        | "ar"
        | "arc"
        | "arn"
        | "arq"
        | "ary"
        | "arz"
        | "as"
        | "ase"
        | "ast"
        | "atj"
        | "av"
        | "avk"
        | "awa"
        | "ay"
        | "az"
        | "azb"
        | "ba"
        | "bag"
        | "ban"
        | "ban-bali"
        | "bar"
        | "bas"
        | "bat-smg"
        | "bax"
        | "bbc"
        | "bbc-latn"
        | "bbj"
        | "bcc"
        | "bci"
        | "bcl"
        | "bdr"
        | "be"
        | "be-tarask"
        | "be-x-old"
        | "bew"
        | "bfd"
        | "bg"
        | "bgc"
        | "bgn"
        | "bh"
        | "bho"
        | "bi"
        | "bjn"
        | "bkc"
        | "bkh"
        | "bkm"
        | "blk"
        | "bm"
        | "bn"
        | "bo"
        | "bpy"
        | "bqi"
        | "bqz"
        | "br"
        | "brh"
        | "bs"
        | "btm"
        | "bto"
        | "bug"
        | "bxr"
        | "byv"
        | "ca"
        | "cak"
        | "cal"
        | "cbk-zam"
        | "ccp"
        | "cdo"
        | "cdo-hant"
        | "cdo-latn"
        | "ce"
        | "ceb"
        | "ch"
        | "chn"
        | "cho"
        | "chr"
        | "chy"
        | "ckb"
        | "cnh"
        | "co"
        | "cps"
        | "cpx"
        | "cpx-hans"
        | "cpx-hant"
        | "cpx-latn"
        | "cr"
        | "crh"
        | "crh-cyrl"
        | "crh-latn"
        | "crh-ro"
        | "cs"
        | "csb"
        | "cu"
        | "cv"
        | "cy"
        | "da"
        | "dag"
        | "de"
        | "de-at"
        | "de-ch"
        | "de-formal"
        | "dga"
        | "din"
        | "diq"
        | "dsb"
        | "dtp"
        | "dty"
        | "dua"
        | "dv"
        | "dz"
        | "ee"
        | "efi"
        | "egl"
        | "el"
        | "eml"
        | "en"
        | "en-ca"
        | "en-gb"
        | "en-us"
        | "eo"
        | "es"
        | "es-419"
        | "es-formal"
        | "et"
        | "eto"
        | "etu"
        | "eu"
        | "ewo"
        | "ext"
        | "fa"
        | "fat"
        | "ff"
        | "fi"
        | "fit"
        | "fiu-vro"
        | "fj"
        | "fkv"
        | "fmp"
        | "fo"
        | "fon"
        | "fr"
        | "frc"
        | "frp"
        | "frr"
        | "fur"
        | "fy"
        | "ga"
        | "gaa"
        | "gag"
        | "gan"
        | "gan-hans"
        | "gan-hant"
        | "gcf"
        | "gcr"
        | "gd"
        | "gl"
        | "gld"
        | "glk"
        | "gn"
        | "gom"
        | "gom-deva"
        | "gom-latn"
        | "gor"
        | "got"
        | "gpe"
        | "grc"
        | "gsw"
        | "gu"
        | "guc"
        | "gur"
        | "guw"
        | "gv"
        | "gya"
        | "ha"
        | "hak"
        | "hak-hans"
        | "hak-hant"
        | "hak-latn"
        | "haw"
        | "he"
        | "hi"
        | "hif"
        | "hif-latn"
        | "hil"
        | "hke"
        | "hno"
        | "ho"
        | "hr"
        | "hrx"
        | "hsb"
        | "hsn"
        | "ht"
        | "hu"
        | "hu-formal"
        | "hy"
        | "hyw"
        | "hz"
        | "ia"
        | "iba"
        | "ibb"
        | "id"
        | "ie"
        | "ig"
        | "igl"
        | "ii"
        | "ik"
        | "ike-cans"
        | "ike-latn"
        | "ilo"
        | "inh"
        | "io"
        | "is"
        | "isu"
        | "isv-cyrl"
        | "isv-latn"
        | "it"
        | "iu"
        | "ja"
        | "jam"
        | "jbo"
        | "jut"
        | "jv"
        | "ka"
        | "kaa"
        | "kab"
        | "kai"
        | "kbd"
        | "kbd-cyrl"
        | "kbp"
        | "kcg"
        | "kea"
        | "ker"
        | "kg"
        | "kge"
        | "khw"
        | "ki"
        | "kiu"
        | "kj"
        | "kjh"
        | "kjp"
        | "kk"
        | "kk-arab"
        | "kk-cn"
        | "kk-cyrl"
        | "kk-kz"
        | "kk-latn"
        | "kk-tr"
        | "kl"
        | "km"
        | "kn"
        | "knc"
        | "ko"
        | "ko-kp"
        | "koi"
        | "kr"
        | "krc"
        | "kri"
        | "krj"
        | "krl"
        | "ks"
        | "ks-arab"
        | "ks-deva"
        | "ksf"
        | "ksh"
        | "ksw"
        | "ku"
        | "ku-arab"
        | "ku-latn"
        | "kum"
        | "kus"
        | "kv"
        | "kw"
        | "ky"
        | "la"
        | "lad"
        | "lb"
        | "lbe"
        | "lem"
        | "lez"
        | "lfn"
        | "lg"
        | "li"
        | "lij"
        | "liv"
        | "lki"
        | "lld"
        | "lmo"
        | "ln"
        | "lns"
        | "lo"
        | "loz"
        | "lrc"
        | "lt"
        | "ltg"
        | "lua"
        | "lus"
        | "luz"
        | "lv"
        | "lzh"
        | "lzz"
        | "mad"
        | "mag"
        | "mai"
        | "map-bms"
        | "mcn"
        | "mcp"
        | "mdf"
        | "mg"
        | "mh"
        | "mhr"
        | "mi"
        | "min"
        | "mk"
        | "ml"
        | "mn"
        | "mnc"
        | "mnc-latn"
        | "mnc-mong"
        | "mni"
        | "mnw"
        | "mo"
        | "mos"
        | "mr"
        | "mrh"
        | "mrj"
        | "ms"
        | "ms-arab"
        | "mt"
        | "mua"
        | "mui"
        | "mus"
        | "mwl"
        | "my"
        | "myv"
        | "mzn"
        | "na"
        | "nah"
        | "nan"
        | "nan-hani"
        | "nan-hant"
        | "nan-latn-pehoeji"
        | "nan-latn-tailo"
        | "nap"
        | "nb"
        | "nds"
        | "nds-nl"
        | "ne"
        | "new"
        | "ng"
        | "nge"
        | "nia"
        | "nit"
        | "niu"
        | "nl"
        | "nl-informal"
        | "nla"
        | "nmg"
        | "nmz"
        | "nn"
        | "nnh"
        | "nnz"
        | "no"
        | "nod"
        | "nog"
        | "nov"
        | "nqo"
        | "nr"
        | "nrm"
        | "nso"
        | "nup"
        | "nv"
        | "ny"
        | "nyn"
        | "nyo"
        | "nys"
        | "oc"
        | "ojb"
        | "olo"
        | "om"
        | "or"
        | "os"
        | "osa-latn"
        | "ota"
        | "pa"
        | "pag"
        | "pam"
        | "pap"
        | "pap-aw"
        | "pcd"
        | "pcm"
        | "pdc"
        | "pdt"
        | "pfl"
        | "pi"
        | "pih"
        | "pl"
        | "pms"
        | "pnb"
        | "pnt"
        | "prg"
        | "ps"
        | "pt"
        | "pt-br"
        | "pwn"
        | "qu"
        | "quc"
        | "qug"
        | "rgn"
        | "rif"
        | "rki"
        | "rm"
        | "rmc"
        | "rmf"
        | "rmy"
        | "rn"
        | "ro"
        | "roa-rup"
        | "roa-tara"
        | "rsk"
        | "ru"
        | "rue"
        | "rup"
        | "ruq"
        | "ruq-cyrl"
        | "ruq-latn"
        | "rut"
        | "rw"
        | "rwr"
        | "ryu"
        | "sa"
        | "sah"
        | "sat"
        | "sc"
        | "scn"
        | "sco"
        | "sd"
        | "sdc"
        | "sdh"
        | "se"
        | "se-fi"
        | "se-no"
        | "se-se"
        | "sei"
        | "ses"
        | "sg"
        | "sgs"
        | "sh"
        | "sh-cyrl"
        | "sh-latn"
        | "shi"
        | "shi-latn"
        | "shi-tfng"
        | "shn"
        | "shy"
        | "shy-latn"
        | "si"
        | "simple"
        | "sjd"
        | "sje"
        | "sju"
        | "sk"
        | "skr"
        | "skr-arab"
        | "sl"
        | "sli"
        | "sm"
        | "sma"
        | "smj"
        | "smn"
        | "sms"
        | "sn"
        | "so"
        | "sq"
        | "sr"
        | "sr-ec"
        | "sr-el"
        | "srn"
        | "sro"
        | "srq"
        | "ss"
        | "st"
        | "stq"
        | "sty"
        | "su"
        | "sv"
        | "sw"
        | "syl"
        | "szl"
        | "szy"
        | "ta"
        | "tay"
        | "tcy"
        | "tdd"
        | "te"
        | "tet"
        | "tg"
        | "tg-cyrl"
        | "tg-latn"
        | "th"
        | "ti"
        | "tig"
        | "tk"
        | "tl"
        | "tly"
        | "tly-cyrl"
        | "tn"
        | "to"
        | "tok"
        | "tpi"
        | "tpv"
        | "tr"
        | "tru"
        | "trv"
        | "ts"
        | "tt"
        | "tt-cyrl"
        | "tt-latn"
        | "ttj"
        | "tum"
        | "tvu"
        | "tw"
        | "ty"
        | "tyv"
        | "tzm"
        | "udm"
        | "ug"
        | "ug-arab"
        | "ug-latn"
        | "uk"
        | "ur"
        | "uz"
        | "uz-cyrl"
        | "uz-latn"
        | "ve"
        | "vec"
        | "vep"
        | "vi"
        | "vls"
        | "vmf"
        | "vmw"
        | "vo"
        | "vot"
        | "vro"
        | "vut"
        | "wa"
        | "wal"
        | "war"
        | "wes"
        | "wls"
        | "wo"
        | "wuu"
        | "wuu-hans"
        | "wuu-hant"
        | "wya"
        | "xal"
        | "xh"
        | "xmf"
        | "xsy"
        | "yas"
        | "yat"
        | "yav"
        | "ybb"
        | "yi"
        | "yo"
        | "yrl"
        | "yue"
        | "yue-hans"
        | "yue-hant"
        | "za"
        | "zea"
        | "zgh"
        | "zgh-latn"
        | "zh"
        | "zh-classical"
        | "zh-cn"
        | "zh-hans"
        | "zh-hant"
        | "zh-hk"
        | "zh-min-nan"
        | "zh-mo"
        | "zh-my"
        | "zh-sg"
        | "zh-tw"
        | "zh-yue"
        | "zu"

    The language of the description. Nearly all languages are supported, but wikidata does not have mul (default for all languages) for descriptions

    value: string

    The value of the description.

    Accessors

    • get internalID(): string

      Create a unique ID for the Description.

      Returns string

      The ID.

    Methods

    • Check if two descriptions are equal.

      Parameters

      • other: LabelAndDescription

        The other label.

      Returns boolean

      True if the descriptions are equal.

      const description1 = new Description({ language: 'en', value: 'foo' });
        const description2 = new Description({ language: 'en', value: 'bar' });

        description1.equals(description2); // false

    • Convert the Description to a JSON format.

      Returns LabelAndDescription

      The Description in JSON format.

      const json = description.toJSON();

    • Create a Description from a language and a value.

      Parameters

      • language: LabelLanguages

        The language of the Description.

      • value: string

        The value of the Description.

      Returns Description

      The Description object.

      const description = Description.fromString('en', 'Douglas Adams');

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods