Class ResourceController

Resource controller.

Hierarchy

ResourceController

Index

Constructors

constructor

Methods

Constructors

constructor

new ResourceController(resourceService: ResourceService): ResourceController

- Defined in src/controllers/resource/resource.controller.ts:28
Parameters
- resourceService: ResourceService
Returns ResourceController

Methods

getResource

getResource(name: string): Promise<string | number | boolean>

- Defined in src/controllers/resource/resource.controller.ts:50
Get a resource.

Parameters
- name: string
  
  The resource name.
Returns Promise<string | number | boolean>

The requested resource.

getResources

getResources(): Promise<ResourceMap>

- Defined in src/controllers/resource/resource.controller.ts:92
Get all resources.

Returns Promise<ResourceMap>

All resources.

resetResource

resetResource(name: string): Promise<NBResource<string | number | boolean>>

- Defined in src/controllers/resource/resource.controller.ts:80
Reset a resource's value.

Parameters
- name: string
  
  The resource name.
Returns Promise<NBResource<string | number | boolean>>

The updated resource.

resourceExists

resourceExists(name: string): Promise<boolean>

- Defined in src/controllers/resource/resource.controller.ts:37
Check if a resource exists.

Parameters
- name: string
  
  The resource name.
Returns Promise<boolean>

Whether or not the resource exists.

setResource

setResource(name: string, value: string): Promise<NBResource<string | number | boolean>>

- Defined in src/controllers/resource/resource.controller.ts:65
Set a resource's value.

Parameters
- name: string
  
  The resource name.
- value: string
  
  The new resource value.
Returns Promise<NBResource<string | number | boolean>>

The updated resource.

Generated using TypeDoc