Serial

Serial は増分 ID を生成するクラスです。双方向通信における RPC リクエストの ID を生成するために使用されます。ID は循環的に生成され、ID が安全な整数値を超えないようにします。ID がその値を超えた場合、1 にリセットされます。

インポート

import { Serial } from "@tai-kun/surrealdb/utils";

.constructor()

new Serial(max?: number);

引数

max

増分 ID の最大値を設定します。1 から 2^53-1 までの整数が有効です。デフォルト値は 2^53-1 です。

返値

new を通じて呼び出された場合、Serial はそのインスタンスを返します。

例

次の例では基本的な使い方を示しています:

import { Serial } from "@tai-kun/surrealdb/utils";

const id = new Serial(3);

console.log(id.next());
console.log(id.next());
console.log(id.next());

console.log(id.next());
console.log(id.next());

id.reset();

console.log(id.next());
console.log(id.next());

出力:

1
2
3
1
2
1
2

.next() インスタンス メソッド

.next は次の ID を取得する関数です。

next(): number;

引数

なし。

返値

1 以上 max 以下の整数を返します。この値が最大値の場合、次に取得する値は 1 です。

.reset() インスタンス メソッド

reset(): void;

引数

なし。

返値

なし。