Skip to content

valkeyrie


valkeyrie / AtomicOperation

Class: AtomicOperation<TRegistry>

Defined in: valkeyrie.ts:1342

Type Parameters

TRegistry

TRegistry extends SchemaRegistryType = readonly []

Constructors

Constructor

ts
new AtomicOperation<TRegistry>(valkeyrie: Valkeyrie<TRegistry>): AtomicOperation<TRegistry>;

Defined in: valkeyrie.ts:1351

Parameters

valkeyrie

Valkeyrie<TRegistry>

Returns

AtomicOperation<TRegistry>

Methods

check()

ts
check(...checks: AtomicCheck[]): AtomicOperation<TRegistry>;

Defined in: valkeyrie.ts:1368

Parameters

checks

...AtomicCheck[]

Returns

AtomicOperation<TRegistry>


mutate()

ts
mutate(...mutations: Mutation<unknown>[]): AtomicOperation<TRegistry>;

Defined in: valkeyrie.ts:1380

Parameters

mutations

...Mutation<unknown>[]

Returns

AtomicOperation<TRegistry>


set()

ts
set<TKey>(
   key: TKey, 
   value: InferTypeForKey<TRegistry, TKey>, 
options: SetOptions): AtomicOperation<TRegistry>;

Defined in: valkeyrie.ts:1445

Type Parameters

TKey

TKey extends Key

Parameters

key

TKey

value

InferTypeForKey<TRegistry, TKey>

options

SetOptions = {}

Returns

AtomicOperation<TRegistry>


delete()

ts
delete(key: Key): AtomicOperation<TRegistry>;

Defined in: valkeyrie.ts:1458

Parameters

key

Key

Returns

AtomicOperation<TRegistry>


sum()

ts
sum(key: Key, value: bigint | KvU64): AtomicOperation<TRegistry>;

Defined in: valkeyrie.ts:1462

Parameters

key

Key

value

bigint | KvU64

Returns

AtomicOperation<TRegistry>


max()

ts
max(key: Key, value: bigint | KvU64): AtomicOperation<TRegistry>;

Defined in: valkeyrie.ts:1467

Parameters

key

Key

value

bigint | KvU64

Returns

AtomicOperation<TRegistry>


min()

ts
min(key: Key, value: bigint | KvU64): AtomicOperation<TRegistry>;

Defined in: valkeyrie.ts:1472

Parameters

key

Key

value

bigint | KvU64

Returns

AtomicOperation<TRegistry>


commit()

ts
commit(): Promise<
  | {
  ok: true;
  versionstamp: string;
}
  | {
  ok: false;
}>;

Defined in: valkeyrie.ts:1477

Returns

Promise< | { ok: true; versionstamp: string; } | { ok: false; }>

Released under the MIT License.