NamedResource

Class: NamedResource<T>

Type parameters

Name	Type
T	extends ResourceType

Hierarchy

• Resource<T>

  ↳ NamedResource

  ↳↳ Scene

  ↳↳ Zone

Table of contents

Constructors

• constructor

Properties

• data
• hue
• manager
• type

Accessors

• archeType
• id
• identifier
• name

Methods

• _clone
• _patch
• _update
• edit
• isType
• setArcheType
• setName

Constructors

constructor

• new NamedResource<T>(bridge, data)

Type parameters

Name	Type
T	extends ResourceType

Parameters

Name	Type
bridge	Hue
data	ResourceTypeGet<T> & { metadata: { archetype: ArcheType ; name: string } }

Overrides

Resource.constructor

Defined in

src/structures/NamedResource.ts:15

Properties

data

• data: ResourceTypeGet<T> & { metadata: { archetype: ArcheType ; name: string } }

Overrides

Resource.data

Defined in

src/structures/NamedResource.ts:13

---

hue

• Readonly hue: Hue

Inherited from

Resource.hue

Defined in

src/structures/Resource.ts:51

---

manager

• Readonly Abstract manager: Manager<T>

Inherited from

Resource.manager

Defined in

src/structures/Resource.ts:53

---

type

• Readonly Abstract type: ResourceType

Inherited from

Resource.type

Defined in

src/structures/Resource.ts:52

Accessors

archeType

• get archeType(): ArcheType

Returns

ArcheType

Defined in

src/structures/NamedResource.ts:24

---

id

• get id(): string

Returns

string

Inherited from

Resource.id

Defined in

src/structures/Resource.ts:56

---

identifier

• get identifier(): ResourceIdentifier<ResourceType>

Returns

ResourceIdentifier<ResourceType>

Inherited from

Resource.identifier

Defined in

src/structures/Resource.ts:60

---

name

• get name(): string

Returns

string

Defined in

src/structures/NamedResource.ts:20

Methods

_clone

▸ _clone(): NamedResource<T>

Returns

NamedResource<T>

Inherited from

Resource._clone

Defined in

src/structures/Resource.ts:77

---

_patch

▸ _patch(data): void

Parameters

Name	Type
data	Partial<ResourceTypeGet<T>>

Returns

void

Inherited from

Resource._patch

Defined in

src/structures/Resource.ts:73

---

_update

▸ _update(data): NamedResource<T>

Parameters

Name	Type
data	Partial<ResourceTypeGet<T>>

Returns

NamedResource<T>

Inherited from

Resource._update

Defined in

src/structures/Resource.ts:81

---

edit

▸ Abstract edit(options): Promise<void>

Parameters

Name	Type
options	Object
options.archeType?	ArcheType
options.name?	string

Returns

Promise<void>

Defined in

src/structures/NamedResource.ts:36

---

isType

▸ isType<T>(type): this is NarrowResource<T>

Type parameters

Name	Type
T	extends ResourceType

Parameters

Name	Type
type	T

Returns

this is NarrowResource<T>

Inherited from

Resource.isType

Defined in

src/structures/Resource.ts:69

---

setArcheType

▸ setArcheType(archeType): Promise<void>

Parameters

Name	Type
archeType	ArcheType

Returns

Promise<void>

Defined in

src/structures/NamedResource.ts:32

---

setName

▸ setName(name): Promise<void>

Parameters

Name	Type
name	string

Returns

Promise<void>

Defined in

src/structures/NamedResource.ts:28