Class FirestormMetadataStore

Class containing all the metadatas stored in firestorm

Index

Constructors

Accessors

registeredTypes

Methods

getMetadatas getOrCreateMetadatas hasMetadatas registerForwardRef

Constructors

constructor

new FirestormMetadataStore(): FirestormMetadataStore
Returns FirestormMetadataStore

Accessors

registeredTypes

get registeredTypes(): Type<any>[]
Gets the list of all the types that have been registered

Returns Type<any>[]
- Defined in packages/firestorm/src/core/firestorm-metadata-store.ts:48

Methods

getMetadatas

getMetadatas<T>(type: Type<T>): FirestormMetadata<T>
Gets the metadatas of a type
Type Parameters
- T
Parameters
- type: Type<T>
  Type to retrieves the metadas from
Returns FirestormMetadata<T>
Throws
NotFoundMetadataError if there are not metadatas for this type
- Defined in packages/firestorm/src/core/firestorm-metadata-store.ts:39

getOrCreateMetadatas

getOrCreateMetadatas<T>(type: Type<T>): FirestormMetadata<T>
Create if needed and then returns the metadatas of a type
Type Parameters
- T
  The static type of the type to register
Parameters
- type: Type<T>
  Type to retrieve
Returns FirestormMetadata<T>
The metadatas of the type.
- Defined in packages/firestorm/src/core/firestorm-metadata-store.ts:59

hasMetadatas

hasMetadatas<T>(type: Type<T>): boolean
Checks if a specific type as metadatas associated
Type Parameters
- T
Parameters
- type: Type<T>
  Type to check the existency of metadatas on
Returns boolean
True if it has metadatas, false otherwise
- Defined in packages/firestorm/src/core/firestorm-metadata-store.ts:28

registerForwardRef

registerForwardRef<T>(
forwardRef: ForwardRef<T>,
action: ForwardRefAction<T>,
): void
Registers a forward ref.

It is used when two models have references for one another and needs a delayed resolution
Type Parameters
- T
Parameters
- forwardRef: ForwardRef<T>
  Resolver of the type reference
- action: ForwardRefAction<T>
  Action to perform when resolved.
Returns void
- Defined in packages/firestorm/src/core/firestorm-metadata-store.ts:71