Class SubdomainsManager

Manager for subdomains on Discloud

Hierarchy (View Summary)

BaseSubdomainsManager<typeof Subdomain>
- SubdomainsManager

Index

Constructors

constructor

new SubdomainsManager(discloudApp: DiscloudApp): SubdomainsManager
Parameters
- discloudApp: DiscloudApp
Returns SubdomainsManager
Overrides BaseSubdomainsManager.constructor
- Defined in packages/discloud.app/src/managers/SubdomainsManager.ts:13

Properties

`Protected` `Readonly`_cache

_cache: Map<string, Subdomain> = ...

`Readonly`discloudApp

discloudApp: DiscloudApp

`Protected` `Readonly`holds

holds: typeof Subdomain

Accessors

cache

get cache(): Map<K, InstanceType<V>>
Returns Map<K, InstanceType<V>>
Inherited from BaseSubdomainsManager.cache
- Defined in packages/discloud.app/src/managers/DataManager.ts:15

Methods

`Protected`_add

_add(data: PartialApiSubdomain): Subdomain
Parameters
- data: PartialApiSubdomain
Returns Subdomain
Inherited from BaseSubdomainsManager._add
- Defined in packages/discloud.app/src/managers/BaseSubdomainsManager.ts:18

`Protected`_addMany

_addMany(data: PartialApiSubdomain[]): Map<string, Subdomain>
Parameters
- data: PartialApiSubdomain[]
Returns Map<string, Subdomain>
Inherited from BaseSubdomainsManager._addMany
- Defined in packages/discloud.app/src/managers/BaseSubdomainsManager.ts:29

`Protected`_clear

_clear(data?: (string | PartialApiSubdomain)[]): void
Parameters
- Optionaldata: (string | PartialApiSubdomain)[]
Returns void
Inherited from BaseSubdomainsManager._clear
- Defined in packages/discloud.app/src/managers/BaseSubdomainsManager.ts:40

`Protected`_delete

_delete(id: string): boolean
Parameters
- id: string
Returns boolean
Inherited from BaseSubdomainsManager._delete
- Defined in packages/discloud.app/src/managers/BaseSubdomainsManager.ts:55

`Protected`_deleteMany

_deleteMany(ids: string[]): void
Parameters
- ids: string[]
Returns void
Inherited from BaseSubdomainsManager._deleteMany
- Defined in packages/discloud.app/src/managers/BaseSubdomainsManager.ts:60

`Protected`_patch

_patch(id: string, data: Partial<ApiSubdomain>): Subdomain | undefined
Parameters
- id: string
- data: Partial<ApiSubdomain>
Returns Subdomain | undefined
Inherited from BaseSubdomainsManager._patch
- Defined in packages/discloud.app/src/managers/BaseSubdomainsManager.ts:65

create

create(id: string): Promise<Subdomain>
Parameters
- id: string
  You subdomain id.
Returns Promise<Subdomain>
Throws
400

Throws
403

Throws
409 duplicate
- Defined in packages/discloud.app/src/managers/SubdomainsManager.ts:24

delete

delete(id: string): Promise<void>
Parameters
- id: string
  You subdomain id.
Returns Promise<void>
Throws
400

Throws
403

Throws
404 not found

Throws
409 duplicate
- Defined in packages/discloud.app/src/managers/SubdomainsManager.ts:40

fetch

fetch(id: string): Promise<Subdomain>
Get information of your subdomain on Discloud.
Parameters
- id: string
  You subdomain id.
Returns Promise<Subdomain>
Throws
403
- Defined in packages/discloud.app/src/managers/SubdomainsManager.ts:53
fetch(id?: "all"): Promise<Map<string, Subdomain>>
Parameters
- Optionalid: "all"
  You subdomain id.
Returns Promise<Map<string, Subdomain>>
Throws
403

Throws
404 not found
- Defined in packages/discloud.app/src/managers/SubdomainsManager.ts:60

resolve

resolve(keyOrInstance: string | Subdomain): Subdomain | null
Resolves a data entry to a data Object.
Parameters
- keyOrInstance: string | Subdomain
  The id or instance of something in this Manager
Returns Subdomain | null
Inherited from BaseSubdomainsManager.resolve
- Defined in packages/discloud.app/src/managers/DataManager.ts:23

valueOf

valueOf(): Map<string, Subdomain>
Returns the primitive value of the specified object.

Returns Map<string, Subdomain>
Inherited from BaseSubdomainsManager.valueOf
- Defined in packages/discloud.app/src/managers/DataManager.ts:31

Class SubdomainsManager

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SubdomainsManager

Properties

Protected Readonly_cache

ReadonlydiscloudApp

Protected Readonlyholds

Accessors

cache

Returns Map<K, InstanceType<V>>

Methods

Protected_add

Parameters

Returns Subdomain

Protected_addMany

Parameters

Returns Map<string, Subdomain>

Protected_clear

Parameters

Returns void

Protected_delete

Parameters

Returns boolean

Protected_deleteMany

Parameters

Returns void

Protected_patch

Parameters

Returns Subdomain | undefined

create

Parameters

Returns Promise<Subdomain>

Throws

Throws

Throws

delete

Parameters

Returns Promise<void>

Throws

Throws

Throws

Throws

fetch

Parameters

Returns Promise<Subdomain>

Throws

Parameters

Returns Promise<Map<string, Subdomain>>

Throws

Throws

resolve

Parameters

Returns Subdomain | null

valueOf

Returns Map<string, Subdomain>

Settings

On This Page

`Protected` `Readonly`_cache

`Readonly`discloudApp

`Protected` `Readonly`holds

`Protected`_add

`Protected`_addMany

`Protected`_clear

`Protected`_delete

`Protected`_deleteMany

`Protected`_patch