Class CommonsMediaSnak

constructor

• new CommonsMediaSnak(snak: CommonsMediaSnak): CommonsMediaSnak

  Parameters

  • snak: CommonsMediaSnak

    The snak for this class in JSON format.

  Returns CommonsMediaSnak

  Example

  const snak = new CommonsMediaSnak(json);
  Copy

datatype

fileName

commonsLink

• get commonsLink(): string

  Gets the link to the Wiki Commons page.

  Returns string

  The link to the Wiki Commons page.

imageLink

• get imageLink(): string

  Gets the link to the image. Uses the Special:Redirect function of Wiki Commons to find the right URL.

  Returns string

  The link to the image.

equals

• equals(other: CommonsMediaSnak): boolean

  This function checks if two snaks are equal.

  Parameters

  • other: CommonsMediaSnak

    The other snak.

  Returns boolean

  True if the snaks are equal.

  Example

  if (snak.equals(other)) {
      // do something
    }
  Copy

toJSON

• toJSON(): CommonsMediaSnak

  Returns CommonsMediaSnak

  The snak as JSON.

  Example

  const json = CommonsSnak.toJSON();
  Copy

StaticfromFileName

• fromFileName(property: `P${number}`, fileName: string): CommonsMediaSnak

  Creates a snak from a property and a file name.

  Parameters

  • property: `P${number}`

    The property of the snak in 'P-form'.
  • fileName: string

    The file name.

  Returns CommonsMediaSnak

  A snak with the given properties.

  Static

  Example

  const snak = CommonsMediaSnak.fromFileName('P18', 'Example.jpg');
  Copy