Class ShortUrl

constructor

• new ShortUrl(json, shClient): ShortUrl

• Parameters

  • json: shortUrlJson
  • shClient: Shlink

  Returns ShortUrl

crawlable

ReadonlydateCreated

deviceLongUrls

domain

forwardQuery

longUrl

meta

ReadonlyshortCode

ReadonlyshortUrl

tags

title

visitsCount

visitsSummary

addTag

• addTag(tag): Promise<void>

• Add a tag to this short url

  Parameters

  • tag: string

  Returns Promise<void>

delete

• delete(): Promise<void>

• Delete this short url

  Returns Promise<void>

deleteVisits

• deleteVisits(): Promise<void>

• Delete the visits from this url

  Returns Promise<void>

getDomains

• getDomains(): Promise<{
      default: {
          baseUrlRedirect: null | string;
          invalidShortUrlRedirect: null | string;
          regular404Redirect: null | string;
      };
      domains: Domain[];
  }>

• Get all configured domains from this server

  Returns Promise<{
      default: {
          baseUrlRedirect: null | string;
          invalidShortUrlRedirect: null | string;
          regular404Redirect: null | string;
      };
      domains: Domain[];
  }>

getQrCode

• getQrCode(size?, margin?, format?, errorCorrection?): Promise<Buffer>

• Get the QR-Code for this ShortUrl

  Parameters

  • size: number = 300
  • margin: number = 0
  • format: "png" | "svg" = "png"
  • errorCorrection: CorrectionTypes = CorrectionTypes.LOW

  Returns Promise<Buffer>

getVisits

• getVisits(startDate?, endDate?, page?, itemsPerPage?, excludeBots?): Promise<{
      maxPages: number;
      page: number;
      visits: Visit[];
  }>

• Get the visits from this url

  Parameters

  • OptionalstartDate: Date
  • OptionalendDate: Date
  • Optionalpage: number
  • OptionalitemsPerPage: number
  • OptionalexcludeBots: boolean

  Returns Promise<{
      maxPages: number;
      page: number;
      visits: Visit[];
  }>

removeTag

• removeTag(tag): Promise<void>

• Remove a tag from this short url

  Parameters

  • tag: string

  Returns Promise<void>

setAndroidRedirectUrl

• setAndroidRedirectUrl(url): Promise<void>

• Set the android redirect url for this short url

  Parameters

  • url: string | URL

  Returns Promise<void>

setCrawlable

• setCrawlable(crawlable): Promise<void>

• Set the crawlable flag for this short url

  Parameters

  • crawlable: boolean

  Returns Promise<void>

setDesktopRedirectUrl

• setDesktopRedirectUrl(url): Promise<void>

• Set the desktop redirect url for this short url

  Parameters

  • url: string | URL

  Returns Promise<void>

setForwardQuarry

• setForwardQuarry(forward): Promise<void>

• Set the forward query flag for this short url

  Parameters

  • forward: boolean

  Returns Promise<void>

setIosRedirectUrl

• setIosRedirectUrl(url): Promise<void>

• Set the ios redirect url for this short url

  Parameters

  • url: string | URL

  Returns Promise<void>

setLongUrl

• setLongUrl(longUrl): Promise<void>

• Set the long url for this short url

  Parameters

  • longUrl: string | URL

  Returns Promise<void>

setMaxVisits

• setMaxVisits(limit): Promise<void>

• Set the max visits for this short url

  Parameters

  • limit: null | number

  Returns Promise<void>

setTags

• setTags(tags): Promise<void>

• Set the tags for this short url

  Parameters

  • tags: string[]

  Returns Promise<void>

setTitle

• setTitle(title): Promise<void>

• Set the title for this short url

  Parameters

  • title: null | string

  Returns Promise<void>

setValidSince

• setValidSince(date): Promise<void>

• Set the valid since date for this short url

  Parameters

  • date: null | Date

  Returns Promise<void>

setValidUntil

• setValidUntil(date): Promise<void>

• Set the valid until date for this short url

  Parameters

  • date: null | Date

  Returns Promise<void>