fp-ts-std/dist/types/Env.d.ts

The missing pseudo-standard library for fp-ts.

/**
 * Helpers for working with the environment in Node.js (located at
 * `process.env`).
 *
 * @since 0.9.0
 */
import * as IOO from "fp-ts/IOOption";
type IOOption<A> = IOO.IOOption<A>;
import * as NES from "./NonEmptyString";
type NonEmptyString = NES.NonEmptyString;
/**
 * Attempt to get an environment parameter.
 *
 * @example
 * import { getParam } from 'fp-ts-std/Env'
 * import * as O from 'fp-ts/Option'
 *
 * assert.deepStrictEqual(getParam('example')(), O.none)
 * process.env['example'] = 'ciao'
 * assert.deepStrictEqual(getParam('example')(), O.some('ciao'))
 *
 * @category 3 Functions
 * @since 0.9.0
 */
export declare const getParam: (k: string) => IOOption<string>;
/**
 * Attempt to get an environment parameter, filtering out empty strings.
 *
 * @example
 * import { getParamNonEmpty } from 'fp-ts-std/Env'
 * import * as O from 'fp-ts/Option'
 *
 * assert.deepStrictEqual(getParamNonEmpty('missing')(), O.none)
 *
 * process.env['non-empty'] = 'ciao'
 * assert.deepStrictEqual(getParamNonEmpty('non-empty')(), O.some('ciao'))
 *
 * process.env['empty'] = ''
 * assert.deepStrictEqual(getParamNonEmpty('empty')(), O.none)
 *
 * @category 3 Functions
 * @since 0.9.0
 */
export declare const getParamNonEmpty: (k: string) => IOOption<NonEmptyString>;
export {};
//# sourceMappingURL=Env.d.ts.map