API Reference

ISequenceIdFactoryinterface

Service for creating, reusing, and releasing sequence-id handles for a context + sequence input.

Quick facts

Kind: interface
Module: sequence-id
Members: 3
Package: @rs-x/core
Source: sequence-id/sequence-id-factory.interface.ts

Declaration

export interface ISequenceIdFactory {
  create(context: unknown, sequence: unknown[]): ISequenceWithId;
  release(context: unknown, id: string): void;
  get(context: unknown, sequence: unknown[]): ISequenceWithId | undefined;
}

Import

import type { ISequenceIdFactory } from '@rs-x/core';

Members

3 members in this interface.

create

method

create(
  context: unknown,
  sequence: unknown[]
): ISequenceWithId

Parameters

Name
Type
Required
context: unknown; required
sequence: unknown[]; required

Returns

ISequenceWithId

get

method

get(
  context: unknown,
  sequence: unknown[]
): ISequenceWithId | undefined

Parameters

Name
Type
Required
context: unknown; required
sequence: unknown[]; required

Returns

ISequenceWithId | undefined

release

method

release(
  context: unknown,
  id: string
): void

Parameters

Name
Type
Required
context: unknown; required
id: string; required

Returns

void