Interface Employed

Public method surface (methods only). employments is public for the Hydrator but is not the contract surface.

interface Employed {
    _removeEmployment(businessPath: string): void;
    _setEmploymentStatus(businessPath: string, status: EmploymentStatus): void;
    _upsertEmployment(record: EmploymentData): void;
    getActiveEmployment(): Employment | undefined;
    getConferredMixinNames(): readonly string[];
    getEmployment(businessPath: string): Employment | undefined;
    getEmployments(): readonly Employment[];
    isOnShift(): boolean;
}

Index

Methods

_removeEmployment _setEmploymentStatus _upsertEmployment getActiveEmployment getConferredMixinNames getEmployment getEmployments isOnShift

Methods

_removeEmployment

_removeEmployment(businessPath: string): void
Privileged: drop the record at businessPath. ApiOnly.
Parameters
- businessPath: string
Returns void
- Defined in packages/server/src/mud/lib/employment/Employed.ts:52

_setEmploymentStatus

_setEmploymentStatus(businessPath: string, status: EmploymentStatus): void
Privileged: set an existing record's status. ApiOnly.
Parameters
- businessPath: string
- status: EmploymentStatus
Returns void
- Defined in packages/server/src/mud/lib/employment/Employed.ts:48

_upsertEmployment

_upsertEmployment(record: EmploymentData): void
Privileged: replace-or-append a full record. ApiOnly.
Parameters
- record: EmploymentData
Returns void
- Defined in packages/server/src/mud/lib/employment/Employed.ts:50

getActiveEmployment

getActiveEmployment(): Employment | undefined
The first still-active (not quit/fired) employment, or undefined.

Returns Employment | undefined
- Defined in packages/server/src/mud/lib/employment/Employed.ts:41

getConferredMixinNames

getConferredMixinNames(): readonly string[]
Mixin names conferred by every on-shift Employment's Position.

Returns readonly string[]
- Defined in packages/server/src/mud/lib/employment/Employed.ts:45

getEmployment

getEmployment(businessPath: string): Employment | undefined
The record at businessPath, or undefined.
Parameters
- businessPath: string
Returns Employment | undefined
- Defined in packages/server/src/mud/lib/employment/Employed.ts:39

getEmployments

getEmployments(): readonly Employment[]
All employment records as value objects.

Returns readonly Employment[]
- Defined in packages/server/src/mud/lib/employment/Employed.ts:37

isOnShift

isOnShift(): boolean
True iff any employment is currently on shift (sync hot-path read).

Returns boolean
- Defined in packages/server/src/mud/lib/employment/Employed.ts:43