Class Link

See

https://docs.kutt.it/#tag/links

Example

const links = new Link(config);

Hierarchy

API
- Link

Index

Constructors

constructor

new Link(config: ConfigI): Link
Parameters
- config: ConfigI
Returns Link
Inherited from API.constructor
- Defined in src/api/API.node.ts:23

Properties

`Private` #request

#request: {
    (options: string | RequestOptions | URL, callback?: ((res: IncomingMessage) => void)): ClientRequest;
    (url: string | URL, options: RequestOptions, callback?: ((res: IncomingMessage) => void)): ClientRequest;
} | {
    (options: string | RequestOptions | URL, callback?: ((res: IncomingMessage) => void)): http.ClientRequest;
    (url: string | URL, options: RequestOptions, callback?: ((res: IncomingMessage) => void)): http.ClientRequest;
}

`Protected` `Readonly` config

config: ConfigI

`Protected` `Readonly` prefix

prefix: "/links" = "/links"

Methods

create

create(link: NewLinkT): Promise<LinkI>

Creates a short link.

Example

const link = await links.create({
  target: "string",
  description: "string",
  expire_in: "2 minutes/hours/days",
  password: "string",
  customurl: "string",
  reuse: false,
  domain: "string",
});

Parameters

link: NewLinkT

Returns Promise<LinkI>

`Protected` delete

delete<Response>(url?: string): Promise<Response>
Protected
Type Parameters
- Response = unknown
Parameters
- Optional url: string
Returns Promise<Response>
Inherited from API.delete
- Defined in src/api/API.ts:32

`Protected` get

get<Response>(url?: string): Promise<Response>
Protected
=
Type Parameters
- Response = unknown
Parameters
- Optional url: string
Returns Promise<Response>
Inherited from API.get
- Defined in src/api/API.ts:44
get<Response>(params: ParamsT, url?: string): Promise<Response>
Protected
Type Parameters
- Response = unknown
Parameters
- params: ParamsT
- Optional url: string
Returns Promise<Response>
Inherited from API.get
- Defined in src/api/API.ts:52

list

list(params?: ListLinkParamsI): Promise<ListLinkResultI>
Gets list of links.

Example
```
const list = await links.list();
```
Example
```
const list = await links.list({
  skip:  0,
  limit: 10,
  all:   10,
});
```
Parameters
- params: ListLinkParamsI = {}
Returns Promise<ListLinkResultI>
- Defined in src/api/Link.ts:52

`Protected` patch

patch<Response>(data: BodyT, url?: string): Promise<Response>
Protected
Type Parameters
- Response = unknown
Parameters
- data: BodyT
- Optional url: string
Returns Promise<Response>
Inherited from API.patch
- Defined in src/api/API.ts:72

`Protected` post

post<Response>(data: BodyT, url?: string): Promise<Response>
Protected
Type Parameters
- Response = unknown
Parameters
- data: BodyT
- Optional url: string
Returns Promise<Response>
Inherited from API.post
- Defined in src/api/API.ts:86

remove

remove(id: string): Promise<string>
Deletes a link.

Example
```
const message = await links.remove(link.id);
```
Parameters
- id: string
Returns Promise<string>
- Defined in src/api/Link.ts:69

`Protected` request

request<Response>(request: RequestI): Promise<Response>
Protected
Type Parameters
- Response = unknown
Parameters
- request: RequestI
Returns Promise<Response>
Inherited from API.request
- Defined in src/api/API.node.ts:34

stats

stats(id: string): Promise<LinkStatsI>
Gets link stats.

Example
```
const stats = await links.stats(link.id);
```
Parameters
- id: string
Returns Promise<LinkStatsI>
- Defined in src/api/Link.ts:81

update

update(id: string, link: UpdateLinkT): Promise<LinkI>

Updates a link.

Example

const updatedLink = await links.update(link.id, {
  target: "string",
  address: "string",
  description: "string",
  expire_in: "2 minutes/hours/days",
});

Parameters

id: string
link: UpdateLinkT

Returns Promise<LinkI>

`Protected` url

url(url: string): string
Protected
Parameters
- url: string
Returns string
Inherited from API.url
- Defined in src/api/API.ts:99

Class Link

See

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

config: ConfigI

Returns Link

Properties

Private #request

Protected Readonly config

Protected Readonly prefix

Methods

create

Example

Parameters

link: NewLinkT

Returns Promise<LinkI>

Protected delete

Type Parameters

Response = unknown

Parameters

Optional url: string

Returns Promise<Response>

Protected get

Type Parameters

Response = unknown

Parameters

Optional url: string

Returns Promise<Response>

Type Parameters

Response = unknown

Parameters

params: ParamsT

Optional url: string

Returns Promise<Response>

list

Example

Example

Parameters

params: ListLinkParamsI = {}

Returns Promise<ListLinkResultI>

Protected patch

Type Parameters

Response = unknown

Parameters

data: BodyT

Optional url: string

Returns Promise<Response>

Protected post

Type Parameters

Response = unknown

Parameters

data: BodyT

Optional url: string

Returns Promise<Response>

remove

Example

Parameters

id: string

Returns Promise<string>

Protected request

Type Parameters

Response = unknown

Parameters

request: RequestI

Returns Promise<Response>

stats

Example

Parameters

id: string

Returns Promise<LinkStatsI>

update

Example

Parameters

`Private` #request

`Protected` `Readonly` config

`Protected` `Readonly` prefix

`Protected` delete

`Optional` url: string

`Protected` get

`Optional` url: string

`Optional` url: string

`Protected` patch

`Optional` url: string

`Protected` post

`Optional` url: string

`Protected` request

`Protected` url