Class SiteLink

constructor

• new SiteLink(siteLink): SiteLink

• Parameters

  • siteLink: SiteLink

    The siteLink for this class

  Returns SiteLink

  Example

  const siteLink = new SiteLink({
        site: 'enwiki',
        title: 'Berlin',
        badges: ['Q17437796'],
        url: 'https://en.wikipedia.org/wiki/Berlin'
    });
  Copy

_url

badges

site

title

internalID

• get internalID(): string

• create a unique id for the site link

  Returns string

  the id

url

• get url(): string

• if the private property _url is set then we know the url already exists else we look it up with wikidata-properties package

  Returns string

  the url of the site link

equals

• equals(other): boolean

• this function checks if SiteLinks are equal

  Parameters

  • other: SiteLink

    the other SiteLink

  Returns boolean

  true if the SiteLink are equal

  Example

  const siteLink1 = new SiteLink({ site: 'enwiki', title: 'foo' });
      const siteLink2 = new SiteLink({ site: 'enwiki', title: 'bar' });
  
      siteLink1.equals(siteLink2); // false
  Copy

toJSON

• toJSON(): SiteLink

• Returns SiteLink

  the SiteLink in a json format

  Example

  const json = siteLink.toJson();
  Copy

Static fromString

• fromString(site, title, badges?, url?): SiteLink

• create a SiteLink from a language and a value

  Parameters

  • site: string

    to what wiki is the site link

  • title: string

    the title of the page

  • Optional badges: string[]

    the badges of the site link like featured article

  • Optional url: string

    the url of the page with domain

  Returns SiteLink

  the SiteLink object

  Example

  const SiteLink = SiteLink.fromString('enwiki', 'Berlin');
  
   // or
  
   const SiteLink = SiteLink.fromString('enwiki', 'Berlin', ['Q17437796']);
  
   // or
  
   const SiteLink = SiteLink.fromString(
       'enwiki',
       'Berlin',
       ['Q17437796'],
       'https://en.wikipedia.org/wiki/Berlin'
   );
  Copy