ShardMapTag<Self, Key, Value, Error>A ShardMap instance tag — wire contract plus stamped key / value / keyOf carriers.
models
Source src/ShardMap.ts:23812 lines
export type type ShardMapTag<Self, Key extends Schema.Top, Value extends Schema.Top, Error extends Schema.Top = Schema.Never> = Hyperlink.HyperlinkTag<Self, {
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<...>;
}, {
...;
}> & {
...;
}
A ShardMap instance tag — wire contract plus stamped key / value / keyOf carriers.
ShardMapTag<
function (type parameter) Self in type ShardMapTag<Self, Key extends Schema.Top, Value extends Schema.Top, Error extends Schema.Top = Schema.Never>Self,
function (type parameter) Key in type ShardMapTag<Self, Key extends Schema.Top, Value extends Schema.Top, Error extends Schema.Top = Schema.Never>Key extends import SchemaSchema.Top,
function (type parameter) Value in type ShardMapTag<Self, Key extends Schema.Top, Value extends Schema.Top, Error extends Schema.Top = Schema.Never>Value extends import SchemaSchema.Top,
function (type parameter) Error in type ShardMapTag<Self, Key extends Schema.Top, Value extends Schema.Top, Error extends Schema.Top = Schema.Never>Error extends import SchemaSchema.Top = typeof 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,
> = interface HyperlinkTag<Self, S extends Spec, Svc = Simplify<{ readonly [K in keyof S]: S[K] extends FromLocalMethod<infer M> ? InjectLocal<M, Self> : S[K] extends LocalMethod<infer T> ? LocalEffect<...> : S[K] extends DefaultMethod<...> ? F : S[K] extends { ...; } ? SuccessOf<...> : S[K] extends { ...; } ? Subscribable<...> : S[K] extends { ...; } ? ClientMethod<...> : S[K] extends Spec ? Simplify<...> : never; }>>The type of a HyperService tag carrying spec S — what
Hyperlink.Tag
produces
(and what you extend). Lets a consumer write
<S extends Spec>(tag: HyperlinkTag<Self, S>) and read the spec through named types
(
specOf
/
groupOf
) instead of a Parameters<typeof specOf> workaround.
HyperlinkTag<function (type parameter) Self in type ShardMapTag<Self, Key extends Schema.Top, Value extends Schema.Top, Error extends Schema.Top = Schema.Never>Self, type ShardMapSpecOf<Key extends Schema.Top, Value extends Schema.Top, Error extends Schema.Top = Schema.Never> = {
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, Schema.Boolean, Error extends Schema.Top ? Error : Schema.Never, false, Hyperlink.MethodAnnotations & {
...;
}, Hyperlink.Derive>;
... 6 more ...;
size: Hyperlink.Marked<...>;
}
Spec produced by
shardMapSpec
.
ShardMapSpecOf<function (type parameter) Key in type ShardMapTag<Self, Key extends Schema.Top, Value extends Schema.Top, Error extends Schema.Top = Schema.Never>Key, function (type parameter) Value in type ShardMapTag<Self, Key extends Schema.Top, Value extends Schema.Top, Error extends Schema.Top = Schema.Never>Value, function (type parameter) Error in type ShardMapTag<Self, Key extends Schema.Top, Value extends Schema.Top, Error extends Schema.Top = Schema.Never>Error>> & {
readonly [import internalinternal.const keySchemaSym: typeof internal.keySchemaSym
export keySchemaSym
Stamped on every ShardMap tag — the key schema.
keySchemaSym]: function (type parameter) Key in type ShardMapTag<Self, Key extends Schema.Top, Value extends Schema.Top, Error extends Schema.Top = Schema.Never>Key;
readonly [import internalinternal.const valueSchemaSym: typeof internal.valueSchemaSym
export valueSchemaSym
Stamped on every ShardMap tag — the value schema.
valueSchemaSym]: function (type parameter) Value in type ShardMapTag<Self, Key extends Schema.Top, Value extends Schema.Top, Error extends Schema.Top = Schema.Never>Value;
readonly [import internalinternal.const keyOfSym: typeof internal.keyOfSym
export keyOfSym
Stamped on every ShardMap tag — extract partition key from a value.
keyOfSym]: (
value: Schema.Schema.Type<Value>value: import SchemaSchema.Schema.type Schema<out T>.Type<S> = S extends {
readonly Type: infer T;
} ? T : never
Extracts the decoded Type from a schema.
Example (Extracting the decoded type)
import { Schema } from "effect"
const Person = Schema.Struct({ name: Schema.String, age: Schema.Number })
type Person = Schema.Schema.Type<typeof Person>
// { readonly name: string; readonly age: number }
Type<function (type parameter) Value in type ShardMapTag<Self, Key extends Schema.Top, Value extends Schema.Top, Error extends Schema.Top = Schema.Never>Value>,
) => import SchemaSchema.Schema.type Schema<out T>.Type<S> = S extends {
readonly Type: infer T;
} ? T : never
Extracts the decoded Type from a schema.
Example (Extracting the decoded type)
import { Schema } from "effect"
const Person = Schema.Struct({ name: Schema.String, age: Schema.Number })
type Person = Schema.Schema.Type<typeof Person>
// { readonly name: string; readonly age: number }
Type<function (type parameter) Key in type ShardMapTag<Self, Key extends Schema.Top, Value extends Schema.Top, Error extends Schema.Top = Schema.Never>Key>;
};
Referenced by 4 symbols