Class Item

constructor

• new Item(item): Item

• Parameters

  • item: ItemInput

    the item in json format

  Returns Item

  Throws

  if the id is not a QString

  Example

  const item = new Item({
           type: "item",
           id: "q2",
  
           labels: {},
           descriptions: {},
           aliases: {},
  
           claims: {},
           sitelinks: {}
     })
  Copy

aliases

descriptions

id

labels

lastrevid

modified

ns

pageid

sitelinks

statements

title

type

internalID

• get internalID(): string

• create a unique id for the Item

  Returns string

  the id

addStatement

• addStatement(statement): void

• adds a statement to the item

  Parameters

  • statement: Statement | Statement[]

    the statement to add

  Returns void

  Example

  const statement = Statement.fromSnak(URLSnak.fromURL("p1", "https://www.wikidata.org"))
    item.addStatement(statement)
  Copy

diff

• diff(other): Changes[]

• finds the difference between two items

  Parameters

  • other: Item

    the other item

  Returns Changes[]

  the changes between the two items

  Example

  const itemA = Item.fromNothing()
    const itemB = Item.fromNothing()
    itemA.addLabel(new Label({language: "nl", value: "Douglas Adams"}))
  
    const changes = itemA.diff(itemB)
    console.log(changes)
  Copy

equals

• equals(other): boolean

• this function checks if two items are equal

  Parameters

  • other: Item

    the other item

  Returns boolean

  true if the items are equal

  Example

  const itemA = Item.fromNothing()
       const itemB = Item.fromNothing()
  
       if(itemA.equals(itemB)){
           alert('the items are the same');
       }
  Copy

findLabel

• findLabel(language): undefined | Label

• tries to find a label int the requested language. if non can be found, it will return undefined

  Parameters

  • language: string

    the language of the label

  Returns undefined | Label

  the labelA label if it found one or undefined

  Example

  const label = item.findLabel("nl")
       console.log(label.value)
       // Douglas Adams
  Copy

removeStatement

• removeStatement(statement): void

• removes a statement from the item

  Parameters

  • statement: Statement

    the statement to remove

  Returns void

  See

  removeStatements

  Example

  const statement = item.statements[0]
      item.removeStatement(statement)
  Copy

removeStatements

• removeStatements(statements): void

• removes multiple statements from the item

  Parameters

  • statements: Statement[]

    the statements to remove

  Returns void

  See

  removeStatement

  Example

  const statements = item.statements
    item.removeStatements(statements)
  Copy

toJSON

• toJSON(): Item

• stringifies the Item into the same json format as the api

  Returns Item

  the item as json

  Example

  const json = item.toJson();
  Copy

Static fromNothing

• fromNothing(): Item

• generates a new empty item object

  Returns Item

  returns a empty item

  Example

  const newItem = Item.fromNothing()
  Copy