Skip to content

Latest commit

 

History

History
225 lines (119 loc) · 4.38 KB

ResourceController.md

File metadata and controls

225 lines (119 loc) · 4.38 KB

@caffedpkg/microcore

@caffedpkg/microcore / ResourceController

Class: ResourceController

Name: ResourceController class Description: Class for managing multiple Resource instances Static methods are for global management Instances are for managing "domains" or different contexts const rc = new ResourceController(options); ResourceController.createResource(options): Resource rc.createImage(options)

Constructors

new ResourceController()

new ResourceController(name): ResourceController

Parameters

name

string | symbol

Returns

ResourceController

Defined in

src/resource/resource.ts:136

Accessors

name

Get Signature

get name(): string

Name: name Description: lists name

Returns

string

Readonly

Defined in

src/resource/resource.ts:153

resources

Get Signature

get resources(): Readonly<Record<string, Resource<any>>>

Name: resources Description: lists resources

Returns

Readonly<Record<string, Resource<any>>>

Readonly<Record<string, Resource>>

Defined in

src/resource/resource.ts:163

Methods

create()

create<T>(params): void | Readonly<Resource<T>>

Name: create Description: create resource

Type Parameters

• T = any

Parameters

params

CreateResourceParams<T>

CreateResourceParams

Returns

void | Readonly<Resource<T>>

void | Readonly<Resource>

Defined in

src/resource/resource.ts:178

delete()

delete(name): boolean

Name: delete Description: delete resource by name

Parameters

name

string | symbol

Returns

boolean

boolean

Defined in

src/resource/resource.ts:219

get()

get(name): void | Readonly<Resource<any>>

Name: get Description: gets resource by name

Parameters

name

string | symbol

Returns

void | Readonly<Resource<any>>

void | Readonly<Resource>

Defined in

src/resource/resource.ts:241

update()

update<T>(params): void | Readonly<Resource<T>>

Name: update Description: updates resource by name

Type Parameters

• T = any

Parameters

params

Partial<CreateResourceParams<T>>

CreateResourceParams

Returns

void | Readonly<Resource<T>>

void | Readonly<Resource>

Defined in

src/resource/resource.ts:252

list()

static list(): Readonly<AnyObject<any>>

Returns

Readonly<AnyObject<any>>

Defined in

src/resource/resource.ts:113

validateIdString()

static validateIdString(str): boolean

Ensures strings do not contain a colon : in them.

Parameters

str

string

Returns

boolean

Defined in

src/resource/resource.ts:128