CustomQueueInstanceSpec<F>Full custom-queue instance contract for itemSchema F.
models
Source src/CustomQueueHyperlink.ts:3056 lines
export type type CustomQueueInstanceSpec<
F extends Schema.Struct.Fields
> = Omit<
{
add: any
enqueue: any
release: any
releaseEncoded: any
deadLetter: any
drop: any
events: any
status: any
size: any
isEmpty: any
levelSizes: any
start: any
pause: any
resume: any
shutdown: any
clear: any
metrics: {
stream: any
query: any
}
},
"add"
> & {
readonly add: CustomQueueAddMethod
}
Full custom-queue instance contract for itemSchema F.
CustomQueueInstanceSpec<function (type parameter) F in type CustomQueueInstanceSpec<F extends Schema.Struct.Fields>F extends import SchemaSchema.Struct.type Struct<Fields extends Struct.Fields>.Fields = {
readonly [x: string]: Schema.Constraint;
readonly [x: number]: Schema.Constraint;
readonly [x: symbol]: Schema.Constraint;
}
Constraint for a struct field map: an object whose values are schemas.
Fields> = type Omit<T, K extends keyof any> = {
[P in Exclude<keyof T, K>]: T[P]
}
Construct a type with the properties of T except for those in type K.
Omit<
type ReturnType<
T extends (...args: any) => any
> = T extends (...args: any) => infer R ? R : any
Obtain the return type of a function type
ReturnType<typeof const customQueueSpec: <
F extends Schema.Struct.Fields
>(
itemSchema: Schema.Struct<F>,
levelConfig: CustomQueueLevelConfig,
wire?: {
readonly success?: Schema.Top
readonly error?: Schema.Top
}
) => {
add: any
enqueue: any
release: any
releaseEncoded: any
deadLetter: any
drop: any
events: any
status: any
size: any
isEmpty: any
levelSizes: any
start: any
pause: any
resume: any
shutdown: any
clear: any
metrics: {
stream: any
query: any
}
}
Build a custom-queue instance spec: shared
customQueueControlSpec
plus
per-instance data-plane procedures typed by itemSchema.
customQueueSpec<function (type parameter) F in type CustomQueueInstanceSpec<F extends Schema.Struct.Fields>F>>,
"add"
> & {
readonly add: CustomQueueAddMethodadd: type CustomQueueAddMethod = Method<
Schema.Tuple<readonly [Schema.Top, Schema.Top]>,
Schema.Void,
Schema.Never,
false,
any
>
Wire add member — tuple payload surfaced as add(item, level?).
CustomQueueAddMethod;
};
Referenced by 8 symbols