Type Alias MockHashtreeService

MockHashtreeService: MockService<MockHashtreeState> & {
    advance(jobId?: string): boolean;
    failJob(jobId: string, error?: string): boolean;
    setNextPick(pick: HashtreeRuntimeFileSet | "cancel"): void;
}

The hashtree mock with job and picker controls.

Type Declaration

advance: function
- advance(jobId?: string): boolean
  Advance one or every queued/running job by one step.
  Parameters
  - OptionaljobId: string
    Only this job; omit for all.
  Returns boolean
  Whether any job advanced.
  - Defined in packages/mocks/src/domains/hashtree.ts:180
failJob: function
- failJob(jobId: string, error?: string): boolean
  Fail a job, pushing hashtree.error.
  Parameters
  - jobId: string
    Job to fail.
  - Optionalerror: string
    Error code. Default store-failed.
  Returns boolean
  Whether the job existed and was still in progress.
  - Defined in packages/mocks/src/domains/hashtree.ts:188
setNextPick: function
- setNextPick(pick: HashtreeRuntimeFileSet | "cancel"): void
  Script the next pickFiles outcome.
  Parameters
  - pick: HashtreeRuntimeFileSet | "cancel"
    A file set, or 'cancel' for file-pick-cancelled.
  Returns void
  - Defined in packages/mocks/src/domains/hashtree.ts:194

Example

const service = createMockHashtreeService();
service.setNextPick('cancel');
service.advance();

Type Alias MockHashtreeService

Type Declaration

advance: function

Parameters

Returns boolean

failJob: function

Parameters

Returns boolean

setNextPick: function

Parameters

Returns void

Example

Settings