Skip to main content Link Search Menu Expand Document (external link)
effect-libs

NumberBase10Parser overview

This module implements a CVNumberBase10Parser, i.e. an object that can convert a string into a number according to the CVNumberBase10Format that was used to construct it

Table of contents

Constructors

fromFormat

Constructor of a CVNumberBase10Parser from a CVNumberBase10Format

Signature

export declare const fromFormat: (format: CVNumberBase10Format.Type) => Type

Getters

description

Returns the description property of self

Signature

export declare const description: MTypes.OneArgFunction<Type, string>

extractAsBigDecimal

Returns the extractAsBigDecimal property of self.

Signature

export declare const extractAsBigDecimal: MTypes.OneArgFunction<
  Type,
  MTypes.OneArgFunction<string, Option.Option<MTypes.Pair<BigDecimal.BigDecimal, string>>>
>

extractAsBigDecimalOrThrow

Returns the extractAsBigDecimalOrThrow property of self.

Signature

export declare const extractAsBigDecimalOrThrow: MTypes.OneArgFunction<
  Type,
  MTypes.OneArgFunction<string, MTypes.Pair<BigDecimal.BigDecimal, string>>
>

extractAsNumber

Returns the extractAsNumber property of self.

Signature

export declare const extractAsNumber: MTypes.OneArgFunction<
  Type,
  MTypes.OneArgFunction<string, Option.Option<MTypes.Pair<number, string>>>
>

extractAsNumberOrThrow

Returns the extractAsNumberOrThrow property of self.

Signature

export declare const extractAsNumberOrThrow: MTypes.OneArgFunction<
  Type,
  MTypes.OneArgFunction<string, MTypes.Pair<number, string>>
>

parseAsBigDecimal

Returns the parseAsBigDecimal property of self.

Signature

export declare const parseAsBigDecimal: MTypes.OneArgFunction<
  Type,
  MTypes.OneArgFunction<string, Option.Option<BigDecimal.BigDecimal>>
>

parseAsBigDecimalOrThrow

Returns the parseAsBigDecimalOrThrow property of self.

Signature

export declare const parseAsBigDecimalOrThrow: MTypes.OneArgFunction<
  Type,
  MTypes.OneArgFunction<string, BigDecimal.BigDecimal>
>

parseAsNumber

Returns the parseAsNumber property of self.

Signature

export declare const parseAsNumber: MTypes.OneArgFunction<Type, MTypes.OneArgFunction<string, Option.Option<number>>>

parseAsNumberOrThrow

Returns the parseAsNumberOrThrow property of self.

Signature

export declare const parseAsNumberOrThrow: MTypes.OneArgFunction<Type, MTypes.OneArgFunction<string, number>>

Models

Type (class)

Type that represents a CVNumberBase10Parser

Signature

export declare class Type {
  constructor(numberFormat: CVNumberBase10Format.Type)
}

[MData.idSymbol] (method)

Returns the id of this

Signature

[MData.idSymbol](): string | (() => string)

description (property)

Description of this parser, e.g. ‘signed integer parser

Signature

readonly description: string

Module markers

moduleTag

Module tag

Signature

export declare const moduleTag: "@parischap/conversions/formatting/NumberBase10Format/NumberBase10Parser/"