Configuration

This is just an example of the ts-numbers docs.

The Reverse Proxy can be configured using a reverse-proxy.config.ts (or reverse-proxy.config.js) file and it will be automatically loaded when running the reverse-proxy command.

ts-numbers can be configured using a numbers.config.ts (or numbers.config.js) file to set default configuration options for your entire application.

Global Configuration

Create a configuration file in your project root:

// numbers.config.ts
import type { NumbersConfig } from 'ts-numbers'

const config: NumbersConfig = {
  /**
   * Core formatting options
   */
  decimalPlaces: 2,
  decimalCharacter: '.',
  digitGroupSeparator: ',',

  /**
   * Currency options
   */
  currencySymbol: '$',
  currencySymbolPlacement: 'p',

  /**
   * Number constraints
   */
  minimumValue: undefined,
  maximumValue: undefined,

  /**
   * Decimal behavior
   */
  allowDecimalPadding: true,
  alwaysAllowDecimalCharacter: false,

  /**
   * Display and interaction
   */
  caretPositionOnFocus: null,
  emptyInputBehavior: 'focus',
  leadingZero: 'deny',
  negativePositiveSignPlacement: 'l',

  /**
   * Interaction options
   */
  selectOnFocus: false,
  readOnly: false,
  modifyValueOnWheel: false,

  /**
   * Miscellaneous
   */
  roundingMethod: 'S',
  verbose: false,
}

export default config

Then import and use it in your application:

import { Numbers } from 'ts-numbers'
import numbersConfig from './numbers.config'

// Create a new instance with global config
const myInput = new Numbers('#my-input', {
  ...numbersConfig,
  // Override specific options as needed
  decimalPlaces: 4,
})

Configuration Options

ts-numbers provides a wide range of configuration options. Here are the most common ones:

Basic Formatting

{
  // Number of decimal places to display
  decimalPlaces: 2,

  // Character used for the decimal separator
  decimalCharacter: '.',

  // Alternative decimal character (e.g., comma for European formats)
  decimalCharacterAlternative: null,

  // Character used for thousands separator
  digitGroupSeparator: ',',

  // Number of digits between separators
  digitGroupSpacing: 3,
}

Currency Formatting

{
  // Currency symbol to display
  currencySymbol: '$',

  // Placement of currency symbol: 'p' (prefix) or 's' (suffix)
  currencySymbolPlacement: 'p',
}

Number Constraints

{
  // Minimum allowed value
  minimumValue: '0',

  // Maximum allowed value
  maximumValue: '1000',

  // Behavior when value exceeds min/max limits
  // Options: 'ceiling', 'floor', 'ignore', 'invalid'
  overrideMinMaxLimits: 'ceiling',
}

Input Behavior

{
  // Select entire value on focus
  selectOnFocus: true,

  // Where to position cursor on focus
  // Options: 'start', 'end', 'decimalChar', null
  caretPositionOnFocus: 'end',

  // Behavior when input is empty
  // Options: 'focus', 'press', 'always', 'min', 'max', 'zero', 'null'
  emptyInputBehavior: 'zero',
}

Specialized Types

{
  // Type of specialized formatting
  // Options: 'phone', 'temperature', 'weight', 'length', 'time', 'ip', 'creditCard', 'percentage'
  isSpecializedType: 'phone',

  // Options for the specialized type
  specializedOptions: {
    // For phone numbers
    phoneFormat: '(###) ###-####',
    countryCode: 'US',

    // For temperature
    temperatureUnit: 'C',
    convertTempTo: 'F',
  },
}

Loading from File

The library will automatically load configuration from numbers.config.ts or numbers.config.js if present in your project root. You can also explicitly load a configuration file:

import { loadConfig } from 'ts-numbers'

// Load from a specific path
loadConfig('./path/to/custom-config.js')

To learn more about all available configuration options, refer to the API Reference.