Bluestep JS Documentation
    Preparing search index...

    Class Shlink

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

    Index

    Constructors

    Methods

    • Whether to make this short URL crawlable, making it appear in robots.txt as Allowed

      Parameters

      • crawlable: boolean

      Returns Shlink

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

      Parameters

      • customSlug: string

      Returns Shlink

    • The domain in which the short code should be saved

      Parameters

      • domain: 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 string

    • 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 length of the auto-generated short code (minimum 4, default 5)

      Parameters

      • shortCodeLength: number

      Returns Shlink

    • Array of tags to categorize this short URL

      Parameters

      • tags: string[]

      Returns Shlink

    • A descriptive title for the short URL

      Parameters

      • title: string

      Returns Shlink

    • Whether to validate that the long URL is reachable before creating the short URL

      Parameters

      • validateUrl: boolean

      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