Class DatastoreTime

Hierarchy

Pseudo
- DatastoreTime

Constructors

constructor

new DatastoreTime(
    DatastoreTimeId: string,
    GetRequest: DatastoreGet,
    SetRequest: DatastoreSet,
    Version?: number,
    GlobalKeyAddition?: string,
): DatastoreTime
Parameters
- DatastoreTimeId: string
- GetRequest: DatastoreGet
- SetRequest: DatastoreSet
- OptionalVersion: number
- OptionalGlobalKeyAddition: string
Returns DatastoreTime
Overrides Pseudo.constructor
- Defined in index.ts:342

Properties

EpochTimes

EpochTimes: {
    Daily: number;
    Hourly: number;
    Minutely: number;
    Monthly: number;
    Weeklky: number;
    Yearly: number;
} = EpochTimes

GetRequest

GetRequest: DatastoreGet

OnStep

OnStep: Signal<(Steps: number, IsSessionStep: boolean) => void>

`Readonly`Props

Props: undefined | { [key: string]: unknown }

`Readonly`Restarting

Restarting: false

`Readonly`Running

Running: false

SetRequest

SetRequest: DatastoreSet

Started

Started: Signal<() => void>

Step

Step: undefined | number = undefined

StepConstant

StepConstant: undefined | number = undefined

StepConstants

StepConstants: {
    NextWeek: () => number;
    ThisMonth: () => number;
    ThisWeek: () => number;
    Today: () => number;
    Tomorrow: () => number;
    Yesterday: () => number;
} = StepConstants

StepsOnlyInSession

StepsOnlyInSession: boolean = false

Determines if spent while the DatastoreTime wasn't in a session running with Start() is disregarded

You need to do Snapshot() everytime you save to datastore for this to work properly.

Stopped

Stopped: Signal<() => void>

Methods

BindToNextStep

BindToNextStep(
callback: (NextStep: number) => usePropertyEffectCleanup,
): ServantNext
Parameters
- callback: (NextStep: number) => usePropertyEffectCleanup
Returns ServantNext
- Defined in index.ts:156

BindToOnStep

BindToOnStep(callback: (Steps: number) => usePropertyEffectCleanup): ServantNext
Parameters
- callback: (Steps: number) => usePropertyEffectCleanup
Returns ServantNext
- Defined in index.ts:129

Clear

Clear(): void
Returns void
- Defined in index.ts:235

GetNextStep

GetNextStep(
...args: [relativeStep?: number, relativeStepConstant?: number],
): number
Parameters
- ...args: [relativeStep?: number, relativeStepConstant?: number]
Returns number
- Defined in index.ts:303

GetProp

GetProp(Key: string): unknown
Parameters
- Key: string
Returns unknown
- Defined in index.ts:118

GetServerTimeNow

GetServerTimeNow(): number
Returns number
- Defined in index.ts:125

GetSteps

GetSteps(
...args: [relativeStep?: number, relativeStepConstant?: number],
): number
Parameters
- ...args: [relativeStep?: number, relativeStepConstant?: number]
Returns number
- Defined in index.ts:300

MakeGetRequest

MakeGetRequest(): undefined | DatastoreTimeValue
Returns undefined | DatastoreTimeValue
- Defined in index.ts:204

Restart

Restart(ClockTime?: number, ResetProps?: boolean, ClearStore?: boolean): void
Parameters
- OptionalClockTime: number
- OptionalResetProps: boolean
- OptionalClearStore: boolean
Returns void
- Defined in index.ts:228

Set

Set(ClockTime?: number): void
Parameters
- ClockTime: number = ...
Returns void
- Defined in index.ts:306

SetProp

SetProp(Key: string, Value: unknown): void
Parameters
- Key: string
- Value: unknown
Returns void
- Defined in index.ts:90

SetProps

SetProps(Props: undefined | { [key: string]: unknown }): void
Parameters
- Props: undefined | { [key: string]: unknown }
Returns void
- Defined in index.ts:114

Snapshot

Snapshot(): void
Returns void
- Defined in index.ts:77

Start

Start(ClockTime?: number): void
Parameters
- OptionalClockTime: number
Returns void
- Defined in index.ts:238

Stop

Stop(ResetProps?: boolean, ClearStore?: boolean): void
Parameters
- OptionalResetProps: boolean
- OptionalClearStore: boolean
Returns void
- Defined in index.ts:259

UpdateProp

UpdateProp(Key: string, UpdateFunc: (oldValue: unknown) => unknown): void
Parameters
- Key: string
- UpdateFunc: (oldValue: unknown) => unknown
Returns void
- Defined in index.ts:111

Class DatastoreTime

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DatastoreTime

Properties

EpochTimes

GetRequest

OnStep

ReadonlyProps

ReadonlyRestarting

ReadonlyRunning

SetRequest

Started

Step

StepConstant

StepConstants

StepsOnlyInSession

Stopped

Methods

BindToNextStep

Parameters

Returns ServantNext

BindToOnStep

Parameters

Returns ServantNext

Clear

Returns void

GetNextStep

Parameters

Returns number

GetProp

Parameters

Returns unknown

GetServerTimeNow

Returns number

GetSteps

Parameters

Returns number

MakeGetRequest

Returns undefined | DatastoreTimeValue

Restart

Parameters

Returns void

Set

Parameters

Returns void

SetProp

Parameters

Returns void

SetProps

Parameters

Returns void

Snapshot

Returns void

Start

Parameters

Returns void

Stop

Parameters

Returns void

UpdateProp

Parameters

Returns void

Settings

On This Page

`Readonly`Props

`Readonly`Restarting

`Readonly`Running