TypeTags .IntlCollator

Overview#

The Intl.Collator object enables language-sensitive string comparison.

Usage#

import { TypeTags } from 'typetags'

let local = new Intl.Collator('sv')

TypeTags.get(local)
// → [object Intl.Collator]

console.log(['Z', 'a', 'z', 'ä'].sort(local.compare))
// expected output: ["a", "z", "Z", "ä"]

let german = new Intl.Collator('de')

TypeTags.get(german)
// → [object Intl.Collator]

console.log(['Z', 'a', 'z', 'ä'].sort(german.compare))
// expected output: ["a", "ä", "z", "Z"]

Predicate#

.isIntlCollator(value)#

• Checks if value is or has a default IntlCollator type tag.

const { TypeTags } = require('typetags')

let coll = new Intl.Collator('en')

TypeTags.isIntlCollator(coll)
// → true

TypeTags.isIntlCollator(coll.toString())
// → true

Metadata (TType)#

Signature#

declare type ITypeTags = {
  [key in Types | NestedTypes]: Tags
}

declare interface Predicate {
  predicate(value: any): boolean
}

See MDN Web Docs#