IdentifierSchema
Interface IdentifierSchema
interface IdentifierSchema<Id extends IdentifierRegistryId | undefined, Cfg extends IdentifierConfig> extends BaseSchema<InferIdentifierInput<Id, Cfg>, InferIdentifierOutput<Id, Cfg>, BaseIssue<unknown>>Properties
~run
(dataset: UnknownDataset, config: Config<BaseIssue<unknown>>) => OutputDataset<{ [TKey in string | number | symbol]: ([Id] extends ["ISO/IEC-6523"] ? { identifier: string } & (Cfg extends { requireSchemeId: "always" } ? { schemeId: IdentifierRegistryValue<(...)>["values"] extends Set<V> ? V : never } : { schemeId?: (...)[(...)] extends Set<(...)> ? V : never }) : Cfg extends { requireSchemeId: "never" } ? { identifier: string; schemeId?: undefined } : { identifier: string } & (Cfg extends { requireSchemeId: "always" } ? { schemeId: string } : { schemeId?: string }) & (Cfg extends { requireSchemeVersion: "always" } ? { schemeVersion: string } : Cfg extends { requireSchemeVersion: "optional" } ? { schemeVersion?: (...) | (...) } : { schemeVersion?: undefined }))[TKey] }, BaseIssue<unknown>>Defined in packages/core/src/data-types/schema.ts:15
~standard
Props<{ [TKey in string | number | symbol]: (Cfg extends { requireSchemeId: "never"; requireSchemeVersion?: "never" } ? string : (Cfg extends { requireSchemeId: "always" } ? never : string) | { value: string } & (Cfg extends { requireSchemeId: "always" } ? { schemeId: InferIdentifierInputValue<Id> } : Cfg extends { requireSchemeId: "never" } ? {} : { schemeId?: InferIdentifierInputValue<(...)> }) & (Cfg extends { requireSchemeVersion: "always" } ? { schemeVersion: string } : Cfg extends { requireSchemeVersion: "optional" } ? { schemeVersion?: string } : {}))[TKey] }, { [TKey in string | number | symbol]: ([Id] extends ["ISO/IEC-6523"] ? { identifier: string } & (Cfg extends { requireSchemeId: "always" } ? { schemeId: IdentifierRegistryValue<Id>["values"] extends Set<V> ? V : never } : { schemeId?: IdentifierRegistryValue<(...)>["values"] extends Set<V> ? V : never }) : Cfg extends { requireSchemeId: "never" } ? { identifier: string; schemeId?: undefined } : { identifier: string } & (Cfg extends { requireSchemeId: "always" } ? { schemeId: string } : { schemeId?: string }) & (Cfg extends { requireSchemeVersion: "always" } ? { schemeVersion: string } : Cfg extends { requireSchemeVersion: "optional" } ? { schemeVersion?: string } : { schemeVersion?: undefined }))[TKey] }>The Standard Schema properties.
~types
{ input: { [TKey in string | number | symbol]: (Cfg extends { requireSchemeId: "never"; requireSchemeVersion?: "never" } ? string : (Cfg extends { requireSchemeId: "always" } ? never : string) | { value: string } & (Cfg extends { requireSchemeId: "always" } ? { schemeId: InferIdentifierInputValue<Id> } : Cfg extends { requireSchemeId: "never" } ? {} : { schemeId?: (...) | (...) }) & (Cfg extends { requireSchemeVersion: "always" } ? { schemeVersion: string } : Cfg extends { requireSchemeVersion: "optional" } ? { schemeVersion?: (...) | (...) } : {}))[TKey] }; issue: BaseIssue; output: { [TKey in string | number | symbol]: ([Id] extends ["ISO/IEC-6523"] ? { identifier: string } & (Cfg extends { requireSchemeId: "always" } ? { schemeId: IdentifierRegistryValue<(...)>["values"] extends Set<V> ? V : never } : { schemeId?: (...)[(...)] extends Set<(...)> ? V : never }) : Cfg extends { requireSchemeId: "never" } ? { identifier: string; schemeId?: undefined } : { identifier: string } & (Cfg extends { requireSchemeId: "always" } ? { schemeId: string } : { schemeId?: string }) & (Cfg extends { requireSchemeVersion: "always" } ? { schemeVersion: string } : Cfg extends { requireSchemeVersion: "optional" } ? { schemeVersion?: (...) | (...) } : { schemeVersion?: undefined }))[TKey] } }Type Declaration
input
{ [TKey in string | number | symbol]: (Cfg extends { requireSchemeId: "never"; requireSchemeVersion?: "never" } ? string : (Cfg extends { requireSchemeId: "always" } ? never : string) | { value: string } & (Cfg extends { requireSchemeId: "always" } ? { schemeId: InferIdentifierInputValue<Id> } : Cfg extends { requireSchemeId: "never" } ? {} : { schemeId?: (...) | (...) }) & (Cfg extends { requireSchemeVersion: "always" } ? { schemeVersion: string } : Cfg extends { requireSchemeVersion: "optional" } ? { schemeVersion?: (...) | (...) } : {}))[TKey] }Defined in packages/core/src/data-types/schema.ts:21
issue
BaseIssueDefined in packages/core/src/data-types/schema.ts:23
output
{ [TKey in string | number | symbol]: ([Id] extends ["ISO/IEC-6523"] ? { identifier: string } & (Cfg extends { requireSchemeId: "always" } ? { schemeId: IdentifierRegistryValue<(...)>["values"] extends Set<V> ? V : never } : { schemeId?: (...)[(...)] extends Set<(...)> ? V : never }) : Cfg extends { requireSchemeId: "never" } ? { identifier: string; schemeId?: undefined } : { identifier: string } & (Cfg extends { requireSchemeId: "always" } ? { schemeId: string } : { schemeId?: string }) & (Cfg extends { requireSchemeVersion: "always" } ? { schemeVersion: string } : Cfg extends { requireSchemeVersion: "optional" } ? { schemeVersion?: (...) | (...) } : { schemeVersion?: undefined }))[TKey] }Defined in packages/core/src/data-types/schema.ts:22
Defined in packages/core/src/data-types/schema.ts:19
async
falseDefined in packages/core/src/data-types/schema.ts:14
config
Cfg | undefinedDefined in packages/data-types/src/schemas/identifier.ts:116
expects
stringDefined in packages/core/src/data-types/schema.ts:13
kind
"schema"Defined in packages/core/src/data-types/schema.ts:8
reference
{ (cfg?: Cfg): IdentifierSchema<undefined, Cfg>; (id: Id, cfg?: Cfg): IdentifierSchema<Id, Cfg> }Defined in packages/data-types/src/schemas/identifier.ts:112
registryId
[Id] extends ["ISO/IEC-6523"] ? Id : string | undefinedDefined in packages/data-types/src/schemas/identifier.ts:113
type
"identifier"Defined in packages/data-types/src/schemas/identifier.ts:111
Defined in packages/data-types/src/schemas/identifier.ts:103