Show overview
The Show
type class represents those types which can be converted into a human-readable string
representation.
While not required, it is recommended that for any expression x
, the string show(x)
be executable TypeScript code which evaluates to the same value as the expression x
.
Added in v2.0.0
Table of contents
model
Show (interface)
Signature
export interface Show<A> {
readonly show: (a: A) => string
}
Added in v2.0.0
utils
struct
Signature
export declare const struct: <A>(shows: { [K in keyof A]: Show<A[K]> }) => Show<{ readonly [K in keyof A]: A[K] }>
Added in v2.10.0
tuple
Signature
export declare const tuple: <A extends readonly unknown[]>(
...shows: { [K in keyof A]: Show<A[K]> }
) => Show<Readonly<A>>
Added in v2.10.0
zone of death
getStructShow
Use struct
instead.
Signature
export declare const getStructShow: <O extends Readonly<Record<string, any>>>(shows: {
[K in keyof O]: Show<O[K]>
}) => Show<O>
Added in v2.0.0
getTupleShow
Use tuple
instead.
Signature
export declare const getTupleShow: <T extends readonly Show<any>[]>(
...shows: T
) => Show<{ [K in keyof T]: T[K] extends Show<infer A> ? A : never }>
Added in v2.0.0
showBoolean
Use Show
instead.
Signature
export declare const showBoolean: Show<boolean>
Added in v2.0.0
showNumber
Use Show
instead.
Signature
export declare const showNumber: Show<number>
Added in v2.0.0
showString
Use Show
instead.
Signature
export declare const showString: Show<string>
Added in v2.0.0