node-timetravel

Library for easily running timetravel-as-a-service calls from the command line or inside code.

Usage

npx @raydeck/timetravel [options]

@raydeck/timetravel - v1.0.1

@raydeck/timetravel - v1.0.1

Index

Type aliases

• Endpoint
• RunLaterArgs

Functions

• cancel
• init
• runLater

Type aliases

Endpoint

Ƭ Endpoint: object

Defined in index.ts:147

Where to send the request

Type declaration:

• encoding: GQLPostFormat

• headers(): object

• method: GQLWebRequestMETHOD

• url: string

RunLaterArgs

Ƭ RunLaterArgs: object

Defined in index.ts:160

Arguments for a runLater call

Type declaration:

• id? : undefined | string

• payload(): object

• runOn: Date

• sendTo: Endpoint

• token? : undefined | string

Functions

cancel

▸ cancel(__namedParameters: object): Promise‹any›

Defined in index.ts:227

Cancel a previously-scheduled event

Parameters:

▪ __namedParameters: object

Name | Type | ------ | ------ | id | string | token | string |

Returns: Promise‹any›

Identifier for the archived version of the now-cancelled event

init

▸ init(token: string | AccessObject): Promise‹ApolloClient‹NormalizedCacheObject››

Defined in index.ts:118

Timetravel relationship

Parameters:

Name | Type | Description | ------ | ------ | ------ | token | string | AccessObject | token for setting up timetravel |

Returns: Promise‹ApolloClient‹NormalizedCacheObject››

runLater

▸ runLater(args: RunLaterArgs): Promise‹any›

Defined in index.ts:177

Schedule an event to run in the future

Parameters:

Name | Type | ------ | ------ | args | RunLaterArgs |

Returns: Promise‹any›

identifier for the scheduled event (same as id argument if it was passed)