Class Shlink

Index

Constructors

constructor

new Shlink(host, apiKey): Shlink
Parameters
- host: string | URL
- apiKey: string
Returns Shlink
- Defined in src/ApiClient/Shlink.ts:16

Properties

`Protected`apiKey

apiKey: string

Methods

api

api(options): Promise<unknown>
Send a request to the API
Parameters
- options: RawAxiosRequestConfig
Returns Promise<unknown>
- Defined in src/ApiClient/Shlink.ts:26

createShortUrl

createShortUrl(shortUrlBuilder): Promise<ShortUrl>
Create a new short url
Parameters
- shortUrlBuilder: ShortUrlBuilder
Returns Promise<ShortUrl>
- Defined in src/ApiClient/Shlink.ts:85

deleteTags

deleteTags(tags): Promise<void>
Delete tags from this server
Parameters
- tags: (string | Tag)[]
Returns Promise<void>
- Defined in src/ApiClient/Shlink.ts:160

getShortUrl

getShortUrl(shortCode): Promise<ShortUrl>
Get a specific short url
Parameters
- shortCode: string
Returns Promise<ShortUrl>
- Defined in src/ApiClient/Shlink.ts:72

getShortUrls

getShortUrls(page?, itemsPerPage?, searchTerm?, tags?, tagsMode?, orderBy?, startDate?, endDate?, excludeMaxVisitsReached?, excludePastValidUntil?): Promise<{
    maxPages: number;
    page: number;
    urls: ShortUrl[];
}>
Get all short urls from this server
This will return 10 items per page by default
Parameters
- Optionalpage: number
- OptionalitemsPerPage: number
- OptionalsearchTerm: string
- tags: string[] = []
- OptionaltagsMode: "any" | "all"
- OptionalorderBy: ShortUrlOrderTypes
- OptionalstartDate: Date
- OptionalendDate: Date
- OptionalexcludeMaxVisitsReached: boolean
- OptionalexcludePastValidUntil: boolean
Returns Promise<{
    maxPages: number;
    page: number;
    urls: ShortUrl[];
}>
- Defined in src/ApiClient/Shlink.ts:43

getTags

getTags(includeStats?, page?, itemsPerPage?, searchTerm?, orderBy?): Promise<{
    maxPages: number;
    page: number;
    tags: Tag[];
}>
Get all tags from this server

Important! Ordering by shortUrlsCount, visits or nonBotVisits has a known performance issue which makes loading a subset of the list take as much as loading the whole list.
Parameters
- OptionalincludeStats: boolean
- Optionalpage: number
- OptionalitemsPerPage: number
- OptionalsearchTerm: string
- OptionalorderBy: TagOrderType | StatsTagOrderType
Returns Promise<{
    maxPages: number;
    page: number;
    tags: Tag[];
}>
- Defined in src/ApiClient/Shlink.ts:127

getVisitCount

getVisitCount(): Promise<totalVisitsJson>
Get the visit count from this server

Returns Promise<totalVisitsJson>
- Defined in src/ApiClient/Shlink.ts:178

health

health(): Promise<healthJson>
Get the health status of the server

Returns Promise<healthJson>
- Defined in src/ApiClient/Shlink.ts:98

healthy

healthy(): Promise<boolean>
Check if the server is healthy

Returns Promise<boolean>
- Defined in src/ApiClient/Shlink.ts:117

renameTag

renameTag(tag, newName): Promise<void>
Rename a tag of this server
Parameters
- tag: string | Tag
- newName: string
Returns Promise<void>
- Defined in src/ApiClient/Shlink.ts:146

Class Shlink

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Shlink

Properties

ProtectedapiKey

Methods

api

Parameters

Returns Promise<unknown>

createShortUrl

Parameters

Returns Promise<ShortUrl>

deleteTags

Parameters

Returns Promise<void>

getShortUrl

Parameters

Returns Promise<ShortUrl>

getShortUrls

Parameters

Returns Promise<{ maxPages: number; page: number; urls: ShortUrl[]; }>

getTags

Parameters

Returns Promise<{ maxPages: number; page: number; tags: Tag[]; }>

getVisitCount

Returns Promise<totalVisitsJson>

health

Returns Promise<healthJson>

healthy

Returns Promise<boolean>

renameTag

Parameters

Returns Promise<void>

Settings

On This Page

`Protected`apiKey

Returns Promise<{
maxPages: number;
page: number;
urls: ShortUrl[];
}>

Returns Promise<{
maxPages: number;
page: number;
tags: Tag[];
}>