wooorm/control-pictures

Replace pictures for control character codes with actual control characters

control-pictures

Replace pictures for control character codes with actual control characters.

Contents

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

What is this?

This package replaces pictures for control character codes (such as '␊') with actual control characters (as in, '\n'). It supports U+2400 SYMBOL FOR NULL (␀) through U+2426 SYMBOL FOR SUBSTITUTE FORM TWO (␦).

When should I use this?

Use this package if you:

• have fixtures that would be unreadable or confusing (to tools) if they used control characters
• want to display control characters to users, e.g., trailing spaces

Install

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

npm install controlPictures

In Deno with esm.sh:

import {controlPictures} from 'https://esm.sh/control-pictures@2'

In browsers with esm.sh:

<script type="module">
  import {controlPictures} from 'https://esm.sh/control-pictures@2?bundle'
</script>

Use

import {controlPictures} from 'control-pictures'

controlPictures() //=> ''
controlPictures('␉␊␋␌␍') //=> '\t\n\v\f\r'
controlPictures('␀') //=> '\0'
controlPictures('a␡b') //=> 'a\x7fb'
controlPictures('␤') //=> '\n'

API

This package exports the identifier controlPictures. There is no default export.

controlPictures(value?)

Replace pictures for control character codes with actual control characters. Takes a value with pictures (string), returns a value with actual control codes (string).

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.

Security

This package is safe.

Contribute

Yes please! See How to Contribute to Open Source.

License

MIT © Titus Wormer