Class ShlinkSettings

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

Hierarchy

  • ShlinkSettings

Constructors

constructor

Properties

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

Constructors

constructor

Properties

Optional customSlug

customSlug?: string

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

Optional findIfExists

findIfExists?: string

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

Optional forwardQuery

forwardQuery?: string

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

longUrl

longUrl: string

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

Optional maxVisits

maxVisits?: string

The maximum number of allowed visits for this short code

Optional validSince

validSince?: Instant

The date from which this short code will be valid

Optional validUntil

validUntil?: Instant

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc