Class StoringActor<Entity, Message, Result>`Abstract`

Type Parameters

Entity extends Document & { updated: Timestamp }
Message
Result

Hierarchy (View Summary)

Actor<Message, Result>
- StoringActor
  - SessionStore
  - SubscribableActor

Index

Constructors

Properties

collectionName connector state

Methods

afterEntityRemovedFromCache afterEntityWasCached afterStart beforeShutdown cleanup deleteEntity determineRole getEntity storeEntity updateIndices

Constructors

constructor

new StoringActor<
    Entity extends Document & { updated: Timestamp },
    Message,
    Result,
>(
    name: string,
    system: ActorSystem,
    collectionName: string,
): StoringActor<Entity, Message, Result>
Type Parameters
- Entity extends Document & { updated: Timestamp }
- Message
- Result
Parameters
- name: string
- system: ActorSystem
- collectionName: string
Returns StoringActor<Entity, Message, Result>
Overrides Actor< Message, Result >.constructor
- Defined in backend/src/actors/StoringActor.ts:24

Properties

`Protected` `Readonly`collectionName

collectionName: string

`Protected` `Readonly`connector

connector: DbClient = ...

`Protected` `Abstract`state

state: {
cache: Map<string & BRAND<"UID">, Entity>;
lastTouched: Map<string & BRAND<"UID">, Timestamp>;
}

Methods

`Protected`afterEntityRemovedFromCache

afterEntityRemovedFromCache(_uid: string & BRAND<"UID">): Promise<void>
Parameters
- _uid: string & BRAND<"UID">
Returns Promise<void>
- Defined in backend/src/actors/StoringActor.ts:63

`Protected`afterEntityWasCached

afterEntityWasCached(_uid: string & BRAND<"UID">): Promise<void>
Parameters
- _uid: string & BRAND<"UID">
Returns Promise<void>
- Defined in backend/src/actors/StoringActor.ts:86

afterStart

afterStart(): Promise<void>
Runs after the actor was started and is ready to receive messages.

Returns Promise<void>
Overrides Actor.afterStart
- Defined in backend/src/actors/StoringActor.ts:33

beforeShutdown

beforeShutdown(): Promise<void>
Runs before the actor gets shut down by the actor system

Returns Promise<void>
Overrides Actor.beforeShutdown
- Defined in backend/src/actors/StoringActor.ts:37

`Protected`cleanup

cleanup(): void
Returns void
- Defined in backend/src/actors/StoringActor.ts:67

`Protected`deleteEntity

deleteEntity(uid: string & BRAND<"UID">): Promise<Unit>
Parameters
- uid: string & BRAND<"UID">
Returns Promise<Unit>
- Defined in backend/src/actors/StoringActor.ts:135

`Protected`determineRole

determineRole(
    from: ActorRef,
): Promise<
    [
        UserRole: AccessRole,
        UserID: string & BRAND<"UID">,
        IsTemporaryAccount: boolean,
    ],
>
Parameters
- from: ActorRef
Returns Promise<
    [
        UserRole: AccessRole,
        UserID: string & BRAND<"UID">,
        IsTemporaryAccount: boolean,
    ],
>
- Defined in backend/src/actors/StoringActor.ts:42

`Protected`getEntity

getEntity(uid: string & BRAND<"UID">): Promise<MaybeBase<Entity>>
Parameters
- uid: string & BRAND<"UID">
Returns Promise<MaybeBase<Entity>>
- Defined in backend/src/actors/StoringActor.ts:90

`Protected`storeEntity

storeEntity(entity: Entity): Promise<Entity>
Parameters
- entity: Entity
Returns Promise<Entity>
- Defined in backend/src/actors/StoringActor.ts:115

`Protected` `Abstract`updateIndices

updateIndices(
draft: { cache: Map<string & BRAND<"UID">, Entity> },
entity: Entity,
): void
Parameters
- draft: { cache: Map<string & BRAND<"UID">, Entity> }
- entity: Entity
Returns void
- Defined in backend/src/actors/StoringActor.ts:84