mobx-state-tree/dist/types/utility-types/literal.d.ts

Opinionated, transactional, MobX powered state container

import { ISimpleType, Primitives } from "../../internal";
/**
 * `types.literal` - The literal type will return a type that will match only the exact given type.
 * The given value must be a primitive, in order to be serialized to a snapshot correctly.
 * You can use literal to match exact strings for example the exact male or female string.
 *
 * Example:
 * ```ts
 * const Person = types.model({
 *     name: types.string,
 *     gender: types.union(types.literal('male'), types.literal('female'))
 * })
 * ```
 *
 * @param value The value to use in the strict equal check
 * @returns
 */
export declare function literal<S extends Primitives>(value: S): ISimpleType<S>;
/**
 * Returns if a given value represents a literal type.
 *
 * @param type
 * @returns
 */
export declare function isLiteralType(type: unknown): type is ISimpleType<any>;