fp-ts-std
Version:
The missing pseudo-standard library for fp-ts.
52 lines • 1.25 kB
TypeScript
/**
* Utilities to accommodate `fp-ts/Show`.
*
* @since 0.12.0
*/
import type { Contravariant1 } from "fp-ts/Contravariant";
import type { Show } from "fp-ts/Show";
/**
* Typeclass machinery.
*
* @category 4 Minutiae
* @since 0.12.0
*/
export declare const URI = "Show";
/**
* Typeclass machinery.
*
* @category 4 Minutiae
* @since 0.12.0
*/
export type URI = typeof URI;
declare module "fp-ts/HKT" {
interface URItoKind<A> {
readonly [URI]: Show<A>;
}
}
/**
* Derive an instance for `Show<B>` by providing a function from `B` to `A` and
* a `Show<A>` instance.
*
* @example
* import { Show } from 'fp-ts/Show'
* import * as Str from 'fp-ts/string'
* import { contramap } from 'fp-ts-std/Show'
*
* const showNum: Show<number> = contramap(String)(Str.Show)
*
* assert.strictEqual(showNum.show(123), '"123"')
*
* @category 2 Typeclass Methods
* @since 0.12.0
*/
export declare const contramap: <B, A>(f: (b: B) => A) => (m: Show<A>) => Show<B>;
/**
* Formal `Contravariant` instance for `Show` to be provided to higher-kinded
* functions that require it.
*
* @category 1 Typeclass Instances
* @since 0.12.0
*/
export declare const Contravariant: Contravariant1<URI>;
//# sourceMappingURL=Show.d.ts.map