<Key extends Schema.Top, Value extends Schema.Top>(schemas: {
readonly key: Key
readonly value: Value
readonly error?: undefined
}): ReturnType<typeof buildShardMapSpec<Key, Value, typeof Schema.Never>>
<
Key extends Schema.Top,
Value extends Schema.Top,
Error extends Schema.Top
>(schemas: {
readonly key: Key
readonly value: Value
readonly error: Error
}): ReturnType<typeof buildShardMapSpec<Key, Value, Error>>Build a ShardMap instance spec from key/value schemas (failure channel = Never).
constructors
Source src/ShardMap.ts:17837 lines
export function function shardMapSpec<Key extends Schema.Top, Value extends Schema.Top>(schemas: {
readonly key: Key;
readonly value: Value;
readonly error?: undefined;
}): ReturnType<typeof buildShardMapSpec<Key, Value, typeof Schema.Never>> (+1 overload)
Build a ShardMap instance spec from key/value schemas (failure channel = Never).
shardMapSpec<function (type parameter) Key in shardMapSpec<Key extends Schema.Top, Value extends Schema.Top>(schemas: {
readonly key: Key;
readonly value: Value;
readonly error?: undefined;
}): ReturnType<typeof buildShardMapSpec<Key, Value, typeof Schema.Never>>
import SchemaSchema.Top, function (type parameter) Value in shardMapSpec<Key extends Schema.Top, Value extends Schema.Top>(schemas: {
readonly key: Key;
readonly value: Value;
readonly error?: undefined;
}): ReturnType<typeof buildShardMapSpec<Key, Value, typeof Schema.Never>>
import SchemaSchema.Top>(
schemas: {
readonly key: Key
readonly value: Value
readonly error?: undefined
}
key: Key extends Schema.Topkey: function (type parameter) Key in shardMapSpec<Key extends Schema.Top, Value extends Schema.Top>(schemas: {
readonly key: Key;
readonly value: Value;
readonly error?: undefined;
}): ReturnType<typeof buildShardMapSpec<Key, Value, typeof Schema.Never>>
value: Value extends Schema.Topvalue: function (type parameter) Value in shardMapSpec<Key extends Schema.Top, Value extends Schema.Top>(schemas: {
readonly key: Key;
readonly value: Value;
readonly error?: undefined;
}): ReturnType<typeof buildShardMapSpec<Key, Value, typeof Schema.Never>>
error?: undefinederror?: undefined;
},
): 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 buildShardMapSpec: <Key extends Schema.Top, Value extends Schema.Top, Error extends Schema.Top>(key: Key, value: Value, error: Error) => {
get: Hyperlink.Method<Key extends Schema.Struct.Fields ? Key : Key extends Schema.Top ? Key : never, Schema.Option<Value>, Error extends Schema.Top ? Error : Schema.Never, false, Hyperlink.MethodAnnotations & {
description: string;
}, Hyperlink.Derive>;
put: Hyperlink.Method<Value extends Schema.Struct.Fields ? Value : Value extends Schema.Top ? Value : never, ... 4 more ..., Hyperlink.Derive>;
... 6 more ...;
size: Hyperlink.Marked<...>;
}
function (type parameter) Key in shardMapSpec<Key extends Schema.Top, Value extends Schema.Top>(schemas: {
readonly key: Key;
readonly value: Value;
readonly error?: undefined;
}): ReturnType<typeof buildShardMapSpec<Key, Value, typeof Schema.Never>>
function (type parameter) Value in shardMapSpec<Key extends Schema.Top, Value extends Schema.Top>(schemas: {
readonly key: Key;
readonly value: Value;
readonly error?: undefined;
}): ReturnType<typeof buildShardMapSpec<Key, Value, typeof Schema.Never>>
import SchemaSchema.const Never: Neverconst Never: {
Rebuild: Rebuild;
Iso: Iso;
ast: Ast;
Type: T;
Encoded: E;
DecodingServices: RD;
EncodingServices: RE;
annotate: (annotations: Schema.Annotations.Bottom<never, readonly []>) => Schema.Never;
annotateKey: (annotations: Schema.Annotations.Key<never>) => Schema.Never;
check: (checks_0: Check<never>, ...checks: Array<Check<never>>) => Schema.Never;
rebuild: (ast: Never) => Schema.Never;
make: (input: never, options?: MakeOptions) => never;
makeOption: (input: never, options?: MakeOptions) => Option_.Option<never>;
makeEffect: (input: never, options?: MakeOptions) => Effect.Effect<never, SchemaError, never>;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
}
Type-level representation of
Never
.
Schema for the never type. Always fails validation — no value satisfies it.
Never>
>;
/**
* Build a ShardMap instance spec from key/value/error schemas.
*
* @public
*/
export function function shardMapSpec<Key extends Schema.Top, Value extends Schema.Top, Error extends Schema.Top>(schemas: {
readonly key: Key;
readonly value: Value;
readonly error: Error;
}): ReturnType<typeof buildShardMapSpec<Key, Value, Error>> (+1 overload)
Build a ShardMap instance spec from key/value/error schemas.
shardMapSpec<
function (type parameter) Key in shardMapSpec<Key extends Schema.Top, Value extends Schema.Top, Error extends Schema.Top>(schemas: {
readonly key: Key;
readonly value: Value;
readonly error: Error;
}): ReturnType<typeof buildShardMapSpec<Key, Value, Error>>
import SchemaSchema.Top,
function (type parameter) Value in shardMapSpec<Key extends Schema.Top, Value extends Schema.Top, Error extends Schema.Top>(schemas: {
readonly key: Key;
readonly value: Value;
readonly error: Error;
}): ReturnType<typeof buildShardMapSpec<Key, Value, Error>>
import SchemaSchema.Top,
function (type parameter) Error in shardMapSpec<Key extends Schema.Top, Value extends Schema.Top, Error extends Schema.Top>(schemas: {
readonly key: Key;
readonly value: Value;
readonly error: Error;
}): ReturnType<typeof buildShardMapSpec<Key, Value, Error>>
import SchemaSchema.Top,
>(schemas: {
readonly key: Key
readonly value: Value
readonly error: Error
}
key: Key extends Schema.Topkey: function (type parameter) Key in shardMapSpec<Key extends Schema.Top, Value extends Schema.Top, Error extends Schema.Top>(schemas: {
readonly key: Key;
readonly value: Value;
readonly error: Error;
}): ReturnType<typeof buildShardMapSpec<Key, Value, Error>>
value: Value extends Schema.Topvalue: function (type parameter) Value in shardMapSpec<Key extends Schema.Top, Value extends Schema.Top, Error extends Schema.Top>(schemas: {
readonly key: Key;
readonly value: Value;
readonly error: Error;
}): ReturnType<typeof buildShardMapSpec<Key, Value, Error>>
error: Error extends Schema.Toperror: function (type parameter) Error in shardMapSpec<Key extends Schema.Top, Value extends Schema.Top, Error extends Schema.Top>(schemas: {
readonly key: Key;
readonly value: Value;
readonly error: Error;
}): ReturnType<typeof buildShardMapSpec<Key, Value, Error>>
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 buildShardMapSpec: <Key extends Schema.Top, Value extends Schema.Top, Error extends Schema.Top>(key: Key, value: Value, error: Error) => {
get: Hyperlink.Method<Key extends Schema.Struct.Fields ? Key : Key extends Schema.Top ? Key : never, Schema.Option<Value>, Error extends Schema.Top ? Error : Schema.Never, false, Hyperlink.MethodAnnotations & {
description: string;
}, Hyperlink.Derive>;
put: Hyperlink.Method<Value extends Schema.Struct.Fields ? Value : Value extends Schema.Top ? Value : never, ... 4 more ..., Hyperlink.Derive>;
... 6 more ...;
size: Hyperlink.Marked<...>;
}
function (type parameter) Key in shardMapSpec<Key extends Schema.Top, Value extends Schema.Top, Error extends Schema.Top>(schemas: {
readonly key: Key;
readonly value: Value;
readonly error: Error;
}): ReturnType<typeof buildShardMapSpec<Key, Value, Error>>
function (type parameter) Value in shardMapSpec<Key extends Schema.Top, Value extends Schema.Top, Error extends Schema.Top>(schemas: {
readonly key: Key;
readonly value: Value;
readonly error: Error;
}): ReturnType<typeof buildShardMapSpec<Key, Value, Error>>
function (type parameter) Error in shardMapSpec<Key extends Schema.Top, Value extends Schema.Top, Error extends Schema.Top>(schemas: {
readonly key: Key;
readonly value: Value;
readonly error: Error;
}): ReturnType<typeof buildShardMapSpec<Key, Value, Error>>
function shardMapSpec<Key extends Schema.Top, Value extends Schema.Top>(schemas: {
readonly key: Key;
readonly value: Value;
readonly error?: undefined;
}): ReturnType<typeof buildShardMapSpec<Key, Value, typeof Schema.Never>> (+1 overload)
Build a ShardMap instance spec from key/value schemas (failure channel = Never).
shardMapSpec<
function (type parameter) Key in shardMapSpec<Key extends Schema.Top, Value extends Schema.Top, Error extends Schema.Top>(schemas: {
readonly key: Key;
readonly value: Value;
readonly error?: Error;
}): {
get: Hyperlink.Method<Key extends Schema.Struct<Fields extends Schema.Struct.Fields>.Fields ? Key : Key extends Schema.Top ? Key : never, ... 4 more ..., Hyperlink.Derive>;
... 7 more ...;
size: Hyperlink.Marked<...>;
} | {
...;
}
import SchemaSchema.Top,
function (type parameter) Value in shardMapSpec<Key extends Schema.Top, Value extends Schema.Top, Error extends Schema.Top>(schemas: {
readonly key: Key;
readonly value: Value;
readonly error?: Error;
}): {
get: Hyperlink.Method<Key extends Schema.Struct<Fields extends Schema.Struct.Fields>.Fields ? Key : Key extends Schema.Top ? Key : never, ... 4 more ..., Hyperlink.Derive>;
... 7 more ...;
size: Hyperlink.Marked<...>;
} | {
...;
}
import SchemaSchema.Top,
function (type parameter) Error in shardMapSpec<Key extends Schema.Top, Value extends Schema.Top, Error extends Schema.Top>(schemas: {
readonly key: Key;
readonly value: Value;
readonly error?: Error;
}): {
get: Hyperlink.Method<Key extends Schema.Struct<Fields extends Schema.Struct.Fields>.Fields ? Key : Key extends Schema.Top ? Key : never, ... 4 more ..., Hyperlink.Derive>;
... 7 more ...;
size: Hyperlink.Marked<...>;
} | {
...;
}
import SchemaSchema.Top,
>(schemas: {
readonly key: Key
readonly value: Value
readonly error?: Error
}
key: Key extends Schema.Topkey: function (type parameter) Key in shardMapSpec<Key extends Schema.Top, Value extends Schema.Top, Error extends Schema.Top>(schemas: {
readonly key: Key;
readonly value: Value;
readonly error?: Error;
}): {
get: Hyperlink.Method<Key extends Schema.Struct<Fields extends Schema.Struct.Fields>.Fields ? Key : Key extends Schema.Top ? Key : never, ... 4 more ..., Hyperlink.Derive>;
... 7 more ...;
size: Hyperlink.Marked<...>;
} | {
...;
}
value: Value extends Schema.Topvalue: function (type parameter) Value in shardMapSpec<Key extends Schema.Top, Value extends Schema.Top, Error extends Schema.Top>(schemas: {
readonly key: Key;
readonly value: Value;
readonly error?: Error;
}): {
get: Hyperlink.Method<Key extends Schema.Struct<Fields extends Schema.Struct.Fields>.Fields ? Key : Key extends Schema.Top ? Key : never, ... 4 more ..., Hyperlink.Derive>;
... 7 more ...;
size: Hyperlink.Marked<...>;
} | {
...;
}
error?: Error | undefinederror?: function (type parameter) Error in shardMapSpec<Key extends Schema.Top, Value extends Schema.Top, Error extends Schema.Top>(schemas: {
readonly key: Key;
readonly value: Value;
readonly error?: Error;
}): {
get: Hyperlink.Method<Key extends Schema.Struct<Fields extends Schema.Struct.Fields>.Fields ? Key : Key extends Schema.Top ? Key : never, ... 4 more ..., Hyperlink.Derive>;
... 7 more ...;
size: Hyperlink.Marked<...>;
} | {
...;
}
schemas: {
readonly key: Key
readonly value: Value
readonly error?: Error
}
error?: Error | undefinederror === var undefinedundefined) {
return const buildShardMapSpec: <Key, Value, Schema.Never>(key: Key, value: Value, error: Schema.Never) => {
get: Hyperlink.Method<Key extends Schema.Struct<Fields extends Schema.Struct.Fields>.Fields ? Key : Key extends Schema.Top ? Key : never, Schema.Option<Value>, Schema.Never, false, Hyperlink.MethodAnnotations & {
description: string;
}, Hyperlink.Derive>;
put: Hyperlink.Method<Value extends Schema.Struct.Fields ? Value : Value extends Schema.Top ? Value : never, ... 4 more ..., Hyperlink.Derive>;
... 6 more ...;
size: Hyperlink.Marked<...>;
}
schemas: {
readonly key: Key
readonly value: Value
readonly error?: Error
}
key: Key extends Schema.Topkey, schemas: {
readonly key: Key
readonly value: Value
readonly error?: Error
}
value: Value extends Schema.Topvalue, import SchemaSchema.const Never: Neverconst Never: {
Rebuild: Rebuild;
Iso: Iso;
ast: Ast;
Type: T;
Encoded: E;
DecodingServices: RD;
EncodingServices: RE;
annotate: (annotations: Schema.Annotations.Bottom<never, readonly []>) => Schema.Never;
annotateKey: (annotations: Schema.Annotations.Key<never>) => Schema.Never;
check: (checks_0: Check<never>, ...checks: Array<Check<never>>) => Schema.Never;
rebuild: (ast: Never) => Schema.Never;
make: (input: never, options?: MakeOptions) => never;
makeOption: (input: never, options?: MakeOptions) => Option_.Option<never>;
makeEffect: (input: never, options?: MakeOptions) => Effect.Effect<never, SchemaError, never>;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
}
Type-level representation of
Never
.
Schema for the never type. Always fails validation — no value satisfies it.
Never);
}
return const buildShardMapSpec: <Key, Value, Error>(key: Key, value: Value, error: Error) => {
get: Hyperlink.Method<Key extends Schema.Struct<Fields extends Schema.Struct.Fields>.Fields ? Key : Key extends Schema.Top ? Key : never, Schema.Option<Value>, Error extends Schema.Top ? Error : Schema.Never, false, Hyperlink.MethodAnnotations & {
description: string;
}, Hyperlink.Derive>;
put: Hyperlink.Method<Value extends Schema.Struct.Fields ? Value : Value extends Schema.Top ? Value : never, ... 4 more ..., Hyperlink.Derive>;
... 6 more ...;
size: Hyperlink.Marked<...>;
}
schemas: {
readonly key: Key
readonly value: Value
readonly error?: Error
}
key: Key extends Schema.Topkey, schemas: {
readonly key: Key
readonly value: Value
readonly error?: Error
}
value: Value extends Schema.Topvalue, schemas: {
readonly key: Key
readonly value: Value
readonly error?: Error
}
error?: Error extends Schema.Toperror);
}