Method getParser

repos/effect/packages/effect/src/SchemaAST.ts:1645–1715

@internal

(recur: (ast: AST) => SchemaParser.Parser)

  /** @internal */
  getExpected(): string {
    return globalThis.String(this.symbol)
  }
}

/**
 * The set of primitive types that can appear as a {@link Literal} value.
 *
 * @see {@link Literal}
 *
 * @category models
 * @since 3.10.0
 */
export type LiteralValue = string | number | boolean | bigint

/**
 * AST node matching an exact primitive value (string, number, boolean, or
 * bigint).
 *
 * **Details**
 *
 * Parsing succeeds only when the input is strictly equal (`===`) to the
 * stored `literal`, preserving the input value. Both `0` and `-0` are accepted
 * by either zero literal, and parsing preserves the input's sign. Numeric
 * literals must be finite. `Infinity`, `-Infinity`, and `NaN` are rejected at
 * construction time.
 *
 * **Example** (Creating a literal AST)
 *
 * ```ts import.meta.vitest
 * import { SchemaAST } from "effect"
 *
 * const ast = new SchemaAST.Literal("active")
 * ast.literal // => "active"
 * ```
 *
 * @see {@link LiteralValue}
 * @see {@link isLiteral}
 * @category models
 * @since 4.0.0
 */
export interface Literal extends ASTNode {
  readonly _tag: "Literal"
  readonly literal: LiteralValue
  /** @internal */

  getParser(): SchemaParser.Parser
  /** @internal */

  matchPart(s: string, _options: ParseOptions): LiteralValue | undefined
  /** @internal */

  toCodecJson(): AST
  /** @internal */

  toCodecStringTree(): AST
  /** @internal */

  getExpected(): string