site/node_modules/space-separated-tokens/readme.md

space-separated-tokens

Parse and stringify space-separated tokens.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • parse(value)
  • stringify(values)
• Types
• Compatibility
• Related
• Contribute
• Security
• License

What is this?

This is a tiny package that can parse and stringify space-separated tokens, as used for example in the HTML class attribute, according to the WHATWG spec.

When should I use this?

This package is rather niche, it’s low-level and particularly useful when working with hast.

Install

This package is ESM only. In Node.js (version 14.14+, 16.0+), install with npm:

npm install space-separated-tokens

In Deno with esm.sh:

import {parse, stringify} from 'https://esm.sh/space-separated-tokens@2'

In browsers with esm.sh:

<script type="module">
  import {parse, stringify} from 'https://esm.sh/space-separated-tokens@2?bundle'
</script>

Use

import {parse, stringify} from 'space-separated-tokens'

parse(' foo\tbar\nbaz  ')
//=> ['foo', 'bar', 'baz']

stringify(['foo', 'bar', 'baz'])
//=> 'foo bar baz'

API

This package exports the identifiers parse and stringify. There is no default export.

parse(value)

Parse space-separated tokens (string) to an array of strings (Array<string>), according to the WHATWG spec.

stringify(values)

Serialize an array of strings or numbers (Array<string|number>) to space-separated tokens (string).

👉 Note: it’s not possible to specify empty or whitespace only values.

Types

This package is fully typed with TypeScript. It exports no additional types.

Compatibility

This package is at least compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.0+. It also works in Deno and modern browsers.

Related

• comma-separated-tokens — parse/stringify comma-separated tokens
• collapse-white-space — replace multiple white-space characters with a single space
• property-information — info on HTML properties

Contribute

Yes please! See How to Contribute to Open Source.

Security

This package is safe.

License

MIT © Titus Wormer