index.d.ts

export type Mixed = string | number | boolean | symbol | object

export type Transformer = (value: string, key: string, collection: any[]) => string

export type TransformerMap = {
  [key: string]: Transformer
}

export interface FormatPartial <T extends string> {
  (replacements?: null | undefined): FormatPartial<T>
  (replacements: any): string
  raw: T
}

export interface Format {
  <T extends string> (template: T, replacements?: null | undefined): FormatPartial<T>
  (template: string, replacements: any): string
}

export interface Strat {
  <T extends string> (template: T): FormatPartial<T>

  <T extends string> (template: T, replacements?: null | undefined): FormatPartial<T>
  (template: string, replacements: any): string

  create (transformers?: TransformerMap): Format
  extend (
    prototype: object,
    transformers?: TransformerMap
  ): void

  errors: {
    ERR_ARGS_ARRAY: 'replacements argument must be an array, not a parameter list',
    ERR_NUMBERING_MIX: 'cannot mix implicit & explicit formatting'
  }
}

declare const strat: Strat

export default strat