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

    crawlable? customSlug? domain? findIfExists? forwardQuery? longUrl maxVisits? shortCodeLength? tags? title? validateUrl? validSince? validUntil?

    Constructors

    Properties

    crawlable?: boolean

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

    customSlug?: string

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

    domain?: string

    The domain in which the short code should be saved

    findIfExists?: boolean

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

    forwardQuery?: boolean

    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

    shortCodeLength?: number

    The length of the auto-generated short code (minimum 4, default 5)

    tags?: string[]

    Array of tags to categorize this short URL

    title?: string

    A descriptive title for the short URL

    validateUrl?: boolean

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

    validSince?: InstantOrDate

    The date from which this short code will be valid

    validUntil?: InstantOrDate

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties