Serializable overview
Added in v1.0.0
Serializable represents an object that has self-contained Schema(s)
Table of contents
accessor
exitSchema
Signature
export declare const exitSchema: <IE, E, IA, A>(
self: WithResult<IE, E, IA, A>
) => Schema.Schema<Schema.ExitFrom<IE, IA>, Exit.Exit<E, A>>
Added in v1.0.0
failureSchema
Signature
export declare const failureSchema: <IE, E, IA, A>(self: WithResult<IE, E, IA, A>) => Schema.Schema<IE, E>
Added in v1.0.0
selfSchema
Signature
export declare const selfSchema: <I, A>(self: Serializable<I, A>) => Schema.Schema<I, A>
Added in v1.0.0
successSchema
Signature
export declare const successSchema: <IE, E, IA, A>(self: WithResult<IE, E, IA, A>) => Schema.Schema<IA, A>
Added in v1.0.0
decoding
deserialize
Signature
export declare const deserialize: {
(value: unknown): <I, A>(self: Serializable<I, A>) => Effect.Effect<never, ParseResult.ParseError, A>
<I, A>(self: Serializable<I, A>, value: unknown): Effect.Effect<never, ParseResult.ParseError, A>
}
Added in v1.0.0
deserializeExit
Signature
export declare const deserializeExit: {
(
value: unknown
): <IE, E, IA, A>(self: WithResult<IE, E, IA, A>) => Effect.Effect<never, ParseResult.ParseError, Exit.Exit<E, A>>
<IE, E, IA, A>(
self: WithResult<IE, E, IA, A>,
value: unknown
): Effect.Effect<never, ParseResult.ParseError, Exit.Exit<E, A>>
}
Added in v1.0.0
deserializeFailure
Signature
export declare const deserializeFailure: {
(value: unknown): <IE, E, IA, A>(self: WithResult<IE, E, IA, A>) => Effect.Effect<never, ParseResult.ParseError, E>
<IE, E, IA, A>(self: WithResult<IE, E, IA, A>, value: unknown): Effect.Effect<never, ParseResult.ParseError, E>
}
Added in v1.0.0
deserializeSuccess
Signature
export declare const deserializeSuccess: {
(value: unknown): <IE, E, IA, A>(self: WithResult<IE, E, IA, A>) => Effect.Effect<never, ParseResult.ParseError, A>
<IE, E, IA, A>(self: WithResult<IE, E, IA, A>, value: unknown): Effect.Effect<never, ParseResult.ParseError, A>
}
Added in v1.0.0
encoding
serialize
Signature
export declare const serialize: <I, A>(self: Serializable<I, A>) => Effect.Effect<never, ParseResult.ParseError, I>
Added in v1.0.0
serializeExit
Signature
export declare const serializeExit: {
<E, A>(
value: Exit.Exit<E, A>
): <IE, IA>(self: WithResult<IE, E, IA, A>) => Effect.Effect<never, ParseResult.ParseError, Schema.ExitFrom<IE, IA>>
<IE, E, IA, A>(
self: WithResult<IE, E, IA, A>,
value: Exit.Exit<E, A>
): Effect.Effect<never, ParseResult.ParseError, Schema.ExitFrom<IE, IA>>
}
Added in v1.0.0
serializeFailure
Signature
export declare const serializeFailure: {
<E>(value: E): <IE, IA, A>(self: WithResult<IE, E, IA, A>) => Effect.Effect<never, ParseResult.ParseError, IE>
<IE, E, IA, A>(self: WithResult<IE, E, IA, A>, value: E): Effect.Effect<never, ParseResult.ParseError, IE>
}
Added in v1.0.0
serializeSuccess
Signature
export declare const serializeSuccess: {
<A>(value: A): <IE, E, IA>(self: WithResult<IE, E, IA, A>) => Effect.Effect<never, ParseResult.ParseError, IA>
<IE, E, IA, A>(self: WithResult<IE, E, IA, A>, value: A): Effect.Effect<never, ParseResult.ParseError, IA>
}
Added in v1.0.0
model
Serializable (interface)
Signature
export interface Serializable<I, A> {
readonly [symbol]: Schema.Schema<I, A>
}
Added in v1.0.0
SerializableWithResult (interface)
Signature
export interface SerializableWithResult<IS, S, IE, E, IA, A> extends Serializable<IS, S>, WithResult<IE, E, IA, A> {}
Added in v1.0.0
WithResult (interface)
Signature
export interface WithResult<IE, E, IA, A> {
readonly [symbolResult]: {
readonly Failure: Schema.Schema<IE, E>
readonly Success: Schema.Schema<IA, A>
}
}
Added in v1.0.0
symbol
symbol
Signature
export declare const symbol: typeof symbol
Added in v1.0.0
symbolResult
Signature
export declare const symbolResult: typeof symbolResult
Added in v1.0.0