Used to generate a short url. See [[B.Shlink]]

Hierarchy

  • Shlink

Constructors

Methods

  • A unique custom slug (short code) to be used instead of the generated short code

    Parameters

    • customSlug: string

    Returns Shlink

  • Will force existing matching URL to be returned if found, instead of creating a new one

    Parameters

    • findIfExists: boolean

    Returns Shlink

  • Tells if the query params should be forwarded from the short URL to the long one

    Parameters

    • forwardQuery: boolean

    Returns Shlink

  • This will generate and return the shortcode.

    Returns void

  • The long URL this short URL will redirect to. This is the only REQUIRED parameter.

    Parameters

    • longUrl: string

    Returns Shlink

  • The maximum number of allowed visits for this short code

    Parameters

    • maxVisits: string

    Returns Shlink

  • The date from which this short code will be valid

    Parameters

    Returns Shlink

  • The date (in ISO-8601 format) until which this short code will be valid

    Parameters

    Returns Shlink

Generated using TypeDoc