Class Domain

See

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

Example

const domains = new Domain(config);

Hierarchy

API
- Domain

Index

Constructors

constructor

new Domain(config: ConfigI): Domain
Parameters
- config: ConfigI
Returns Domain
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: "/domains" = "/domains"

Methods

create

create(domain: NewDomainT): Promise<DomainI>
Creates a domain.

Example
```
const domain = await domains.create({
  address: "string",
  homepage: "string",
});
```
Parameters
- domain: NewDomainT
Returns Promise<DomainI>
- Defined in src/api/Domain.ts:27

`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

`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 domain.

Example
```
const message = await domains.remove(domain.id);
```
Parameters
- id: string
Returns Promise<string>
- Defined in src/api/Domain.ts:38

`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

`Protected` url

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

Class Domain

See

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

config: ConfigI

Returns Domain

Properties

Private #request

Protected Readonly config

Protected Readonly prefix

Methods

create

Example

Parameters

domain: NewDomainT

Returns Promise<DomainI>

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>

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>

Protected url

Parameters

url: string

Returns string

Settings

Member Visibility

Theme

`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