Class BaseHistoryFetcher<C>

Fetcher abstract class that provides methods to init and stop the fetching process, also to save and load the work in progress.

Type Parameters

Hierarchy

BaseHistoryFetcher

Index

Constructors

constructor

new BaseHistoryFetcher<C>(options: BaseFetcherOptions<C>, fetcherStateDAL: FetcherStateLevelStorage<C>): BaseHistoryFetcher<C>
Type Parameters
- C
Parameters
- options: BaseFetcherOptions<C>
  
  Fetcher options.
- fetcherStateDAL: FetcherStateLevelStorage<C>
  
  Fetcher state storage.
Returns BaseHistoryFetcher<C>
- Defined in packages/framework/src/services/fetcher/src/baseHistoryFetcher.ts:25

Properties

`Protected` backwardJob

backwardJob: undefined | JobRunner

`Protected` fetcherState

fetcherState: BaseFetcherState<C>

`Protected` fetcherStateDAL

fetcherStateDAL: FetcherStateLevelStorage<C>

Fetcher state storage.

`Protected` forwardJob

forwardJob: undefined | JobRunner

`Protected` options

options: BaseFetcherOptions<C>

Fetcher options.

Methods

`Protected` _checkComplete

_checkComplete(type: "backward" | "forward", ctx: {
    error?: Error;
    jobState: BaseFetcherJobState;
    newItems: boolean;
}): Promise<boolean>
Parameters
- type: "backward" | "forward"
- ctx: {
      error?: Error;
      jobState: BaseFetcherJobState;
      newItems: boolean;
  }
  - Optional error?: Error
  - jobState: BaseFetcherJobState
  - newItems: boolean
Returns Promise<boolean>
- Defined in packages/framework/src/services/fetcher/src/baseHistoryFetcher.ts:353

`Protected` _runJob

_runJob(fetcherType: "backward" | "forward", ctx: {
firstRun: boolean;
interval: number;
}): Promise<number>
Parameters
- fetcherType: "backward" | "forward"
- ctx: {
  firstRun: boolean;
  interval: number;
  }
  - firstRun: boolean
  - interval: number
Returns Promise<number>
- Defined in packages/framework/src/services/fetcher/src/baseHistoryFetcher.ts:223

`Protected` _updateCursors

_updateCursors(type: "backward" | "forward", ctx: {
lastCursors: BaseFetcherPaginationCursors<C>;
prevCursors?: BaseFetcherPaginationCursors<C>;
}): Promise<FetcherJobRunnerUpdateCursorResult<C>>
Parameters
- type: "backward" | "forward"
- ctx: {
  lastCursors: BaseFetcherPaginationCursors<C>;
  prevCursors?: BaseFetcherPaginationCursors<C>;
  }
  - lastCursors: BaseFetcherPaginationCursors<C>
  - Optional prevCursors?: BaseFetcherPaginationCursors<C>
Returns Promise<FetcherJobRunnerUpdateCursorResult<C>>
- Defined in packages/framework/src/services/fetcher/src/baseHistoryFetcher.ts:312

complete

complete(fetcherType: "backward" | "forward"): Promise<void>
Parameters
- fetcherType: "backward" | "forward"
Returns Promise<void>
- Defined in packages/framework/src/services/fetcher/src/baseHistoryFetcher.ts:102

`Protected` getFetcherState

getFetcherState(): Promise<BaseFetcherState<C>>
Initialises the fetcherState class property of the Fetcher instance, could get the data from the data access layer when the fetching progress is restarted.

Returns Promise<BaseFetcherState<C>>
- Defined in packages/framework/src/services/fetcher/src/baseHistoryFetcher.ts:170

getId

getId(): string
Returns string
- Defined in packages/framework/src/services/fetcher/src/baseHistoryFetcher.ts:30

getLastRun

getLastRun(fetcherType?: "backward" | "forward"): Promise<number>
Parameters
- Optional fetcherType: "backward" | "forward"
Returns Promise<number>
- Defined in packages/framework/src/services/fetcher/src/baseHistoryFetcher.ts:121

getNextRun

getNextRun(fetcherType?: "backward" | "forward"): Promise<number>
Parameters
- Optional fetcherType: "backward" | "forward"
Returns Promise<number>
- Defined in packages/framework/src/services/fetcher/src/baseHistoryFetcher.ts:132

getPendingRuns

getPendingRuns(fetcherType?: "backward" | "forward"): Promise<number>
Parameters
- Optional fetcherType: "backward" | "forward"
Returns Promise<number>
- Defined in packages/framework/src/services/fetcher/src/baseHistoryFetcher.ts:150

getState

getState(): Promise<BaseFetcherState<C>>
Returns Promise<BaseFetcherState<C>>
- Defined in packages/framework/src/services/fetcher/src/baseHistoryFetcher.ts:97

init

init(): Promise<void>
Returns Promise<void>
- Defined in packages/framework/src/services/fetcher/src/baseHistoryFetcher.ts:34

`Protected` initJobsFrequencyState

initJobsFrequencyState(jobType: "backward" | "forward"): void
Parameters
- jobType: "backward" | "forward"
Returns void
- Defined in packages/framework/src/services/fetcher/src/baseHistoryFetcher.ts:201

isComplete

isComplete(fetcherType?: "backward" | "forward"): Promise<boolean>
Parameters
- Optional fetcherType: "backward" | "forward"
Returns Promise<boolean>
- Defined in packages/framework/src/services/fetcher/src/baseHistoryFetcher.ts:112

run

run(): Promise<unknown>
Returns Promise<unknown>
- Defined in packages/framework/src/services/fetcher/src/baseHistoryFetcher.ts:70

`Protected` saveFetcherState

saveFetcherState(): Promise<void>
Saves the fetcher state in the data access layer.

Returns Promise<void>
- Defined in packages/framework/src/services/fetcher/src/baseHistoryFetcher.ts:218

stop

stop(): Promise<void>
Returns Promise<void>
- Defined in packages/framework/src/services/fetcher/src/baseHistoryFetcher.ts:92

Class BaseHistoryFetcher<C>

Type Parameters

C

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

C

Parameters

options: BaseFetcherOptions<C>

fetcherStateDAL: FetcherStateLevelStorage<C>

Returns BaseHistoryFetcher<C>

Properties

Protected backwardJob

Protected fetcherState

Protected fetcherStateDAL

Protected forwardJob

Protected options

Methods

Protected _checkComplete

Parameters

type: "backward" | "forward"

ctx: { error?: Error; jobState: BaseFetcherJobState; newItems: boolean; }

Optional error?: Error

jobState: BaseFetcherJobState

newItems: boolean

Returns Promise<boolean>

Protected _runJob

Parameters

fetcherType: "backward" | "forward"

ctx: { firstRun: boolean; interval: number; }

firstRun: boolean

interval: number

Returns Promise<number>

Protected _updateCursors

Parameters

type: "backward" | "forward"

ctx: { lastCursors: BaseFetcherPaginationCursors<C>; prevCursors?: BaseFetcherPaginationCursors<C>; }

lastCursors: BaseFetcherPaginationCursors<C>

Optional prevCursors?: BaseFetcherPaginationCursors<C>

Returns Promise<FetcherJobRunnerUpdateCursorResult<C>>

complete

Parameters

fetcherType: "backward" | "forward"

Returns Promise<void>

Protected getFetcherState

Returns Promise<BaseFetcherState<C>>

getId

Returns string

getLastRun

Parameters

Optional fetcherType: "backward" | "forward"

Returns Promise<number>

getNextRun

Parameters

Optional fetcherType: "backward" | "forward"

Returns Promise<number>

getPendingRuns

Parameters

Optional fetcherType: "backward" | "forward"

Returns Promise<number>

getState

Returns Promise<BaseFetcherState<C>>

init

Returns Promise<void>

Protected initJobsFrequencyState

Parameters

jobType: "backward" | "forward"

Returns void

isComplete

Parameters

Optional fetcherType: "backward" | "forward"

Returns Promise<boolean>

run

Returns Promise<unknown>

Protected saveFetcherState

`Protected` backwardJob

`Protected` fetcherState

`Protected` fetcherStateDAL

`Protected` forwardJob

`Protected` options

`Protected` _checkComplete

ctx: {
error?: Error;
jobState: BaseFetcherJobState;
newItems: boolean;
}

`Optional` error?: Error

`Protected` _runJob

ctx: {
firstRun: boolean;
interval: number;
}

`Protected` _updateCursors

ctx: {
lastCursors: BaseFetcherPaginationCursors<C>;
prevCursors?: BaseFetcherPaginationCursors<C>;
}

`Optional` prevCursors?: BaseFetcherPaginationCursors<C>

`Protected` getFetcherState

`Optional` fetcherType: "backward" | "forward"

`Optional` fetcherType: "backward" | "forward"

`Optional` fetcherType: "backward" | "forward"

`Protected` initJobsFrequencyState

`Optional` fetcherType: "backward" | "forward"

`Protected` saveFetcherState