Interface MetadataMethodBuilder<K>

Defines the source of a typed metadata value for an extension method.

interface MetadataMethodBuilder<K extends string> {
    argument<TValue = unknown>(): MetadataMethod<
        K,
        [value: TValue],
        TValue,
        "argument",
    >;
    compute<TArgs extends any[], TValue>(
        compute: (...args: TArgs) => TValue,
    ): MetadataMethod<K, TArgs, TValue, "computed">;
    value<const TValue>(value: TValue): MetadataMethod<K, [], TValue, "value">;
}

Type Parameters

K extends string

Index

Methods

argument compute value

Methods

argument

argument<TValue = unknown>(): MetadataMethod<
    K,
    [value: TValue],
    TValue,
    "argument",
>
Store the caller's argument, retaining its literal type.
Type Parameters
- TValue = unknown
Returns MetadataMethod<K, [value: TValue], TValue, "argument">
- Defined in libs/schema/src/metadata-extension.ts:49

compute

compute<TArgs extends any[], TValue>(
compute: (...args: TArgs) => TValue,
): MetadataMethod<K, TArgs, TValue, "computed">
Compute metadata from typed arguments; inference uses the callback's return type.
Type Parameters
- TArgs extends any[]
- TValue
Parameters
- compute: (...args: TArgs) => TValue
Returns MetadataMethod<K, TArgs, TValue, "computed">
- Defined in libs/schema/src/metadata-extension.ts:58

value

value<const TValue>(value: TValue): MetadataMethod<K, [], TValue, "value">
Create a zero-argument method that stores a fixed value.
Type Parameters
- const TValue
Parameters
- value: TValue
Returns MetadataMethod<K, [], TValue, "value">
- Defined in libs/schema/src/metadata-extension.ts:56