Class ForkNamespace<T>

A keyed collection of fork records for a single entity type. Each record maps a forked entity back to its origin via entityId → forkId. Records are schema-validated on mutation; invalid state throws InvariantViolationError.

Type Parameters

T extends TCoreEntityForkRecord = TCoreEntityForkRecord

Index

Constructors

constructor

Methods

create get getAll getByForkId remove snapshot validate fromSnapshot

Constructors

constructor

new ForkNamespace<
    T extends
        {
            entityId: string;
            forkedFromArgumentId: string;
            forkedFromArgumentVersion: number;
            forkedFromEntityId: string;
            forkId: string;
        } = {
        entityId: string;
        forkedFromArgumentId: string;
        forkedFromArgumentVersion: number;
        forkedFromEntityId: string;
        forkId: string;
    },
>(
    schema?: TSchema,
): ForkNamespace<T>
Type Parameters
- T extends {
      entityId: string;
      forkedFromArgumentId: string;
      forkedFromArgumentVersion: number;
      forkedFromEntityId: string;
      forkId: string;
  } = {
      entityId: string;
      forkedFromArgumentId: string;
      forkedFromArgumentVersion: number;
      forkedFromEntityId: string;
      forkId: string;
  }
Parameters
- schema: TSchema = CoreEntityForkRecordSchema
Returns ForkNamespace<T>
- Defined in src/lib/core/fork-namespace.ts:23

Methods

create

create(record: T): T
Registers a fork record. Throws if the entityId already exists.
Parameters
- record: T
Returns T
- Defined in src/lib/core/fork-namespace.ts:51

get

get(entityId: string): T | undefined
Returns the fork record for the given entity ID, or undefined.
Parameters
- entityId: string
Returns T | undefined
- Defined in src/lib/core/fork-namespace.ts:64

getAll

getAll(): T[]
Returns all fork records in this namespace.

Returns T[]
- Defined in src/lib/core/fork-namespace.ts:69

getByForkId

getByForkId(forkId: string): T[]
Returns all records that share the given origin forkId.
Parameters
- forkId: string
Returns T[]
- Defined in src/lib/core/fork-namespace.ts:74

remove

remove(entityId: string): T
Removes and returns the fork record for the given entity ID. Throws if not found.
Parameters
- entityId: string
Returns T
- Defined in src/lib/core/fork-namespace.ts:81

snapshot

snapshot(): T[]
Returns a serializable snapshot of all records.

Returns T[]
- Defined in src/lib/core/fork-namespace.ts:95

validate

validate(): TInvariantValidationResult
Validates every record against the namespace's schema.

Returns TInvariantValidationResult
- Defined in src/lib/core/fork-namespace.ts:111

`Static`fromSnapshot

fromSnapshot<
    T extends
        {
            entityId: string;
            forkedFromArgumentId: string;
            forkedFromArgumentVersion: number;
            forkedFromEntityId: string;
            forkId: string;
        } = {
        entityId: string;
        forkedFromArgumentId: string;
        forkedFromArgumentVersion: number;
        forkedFromEntityId: string;
        forkId: string;
    },
>(
    records: T[],
    schema?: TSchema,
): ForkNamespace<T>
Restores a namespace from a previously captured snapshot.
Type Parameters
- T extends {
      entityId: string;
      forkedFromArgumentId: string;
      forkedFromArgumentVersion: number;
      forkedFromEntityId: string;
      forkId: string;
  } = {
      entityId: string;
      forkedFromArgumentId: string;
      forkedFromArgumentVersion: number;
      forkedFromEntityId: string;
      forkId: string;
  }
Parameters
- records: T[]
- Optionalschema: TSchema
Returns ForkNamespace<T>
- Defined in src/lib/core/fork-namespace.ts:100

Class ForkNamespace<T>

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ForkNamespace<T>

Methods

create

Parameters

Returns T

get

Parameters

Returns T | undefined

getAll

Returns T[]

getByForkId

Parameters

Returns T[]

remove

Parameters

Returns T

snapshot

Returns T[]

validate

Returns TInvariantValidationResult

`Static`fromSnapshot

Type Parameters

Parameters

Returns ForkNamespace<T>

Settings

On This Page

Class ForkNamespace<T>

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ForkNamespace<T>

Methods

create

Parameters

Returns T

get

Parameters

Returns T | undefined

getAll

Returns T[]

getByForkId

Parameters

Returns T[]

remove

Parameters

Returns T

snapshot

Returns T[]

validate

Returns TInvariantValidationResult

StaticfromSnapshot

Type Parameters

Parameters

Returns ForkNamespace<T>

Settings

On This Page

`Static`fromSnapshot