Bluestep JS Documentation
    Preparing search index...

    Class ShlinkSettings

    Settings used to generate a short url. See [[B.Shlink]] and https://shlink.io/documentation/

    Index

    Constructors

    constructor

    Properties

    customSlug? findIfExists? forwardQuery? longUrl maxVisits? validSince? validUntil?

    Constructors

    Properties

    customSlug?: string

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

    findIfExists?: string

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

    forwardQuery?: string

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

    longUrl: string

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

    maxVisits?: string

    The maximum number of allowed visits for this short code

    validSince?: Instant

    The date from which this short code will be valid

    validUntil?: Instant

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties