# xtypejs-name-scheme-compact

> xtypejs Compact name scheme

Latest version **0.1.1** (published 2019-01-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install xtypejs-name-scheme-compact
pnpm add xtypejs-name-scheme-compact
yarn add xtypejs-name-scheme-compact
bun add xtypejs-name-scheme-compact
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2019-01-26 |
| First published | 2016-08-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 14 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 357 |
| Author | Lucas Ononiwu |
| Maintainers | lucono |
| Keywords | type, xtype, xtypejs, typeof, data-type, validation |

## Links

- npm: https://www.npmjs.com/package/xtypejs-name-scheme-compact
- Repository: https://github.com/lucono/xtypejs
- Homepage: https://xtype.js.org
- Issues: https://github.com/lucono/xtypejs/issues
- npm.io page: https://npm.io/package/xtypejs-name-scheme-compact

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 0.1.1 (latest) — 2019-01-26
- 0.1.0 — 2016-08-15

## README

# xtypejs - Name scheme: `compact`

### Installation with npm

```sh
npm install xtypejs-name-scheme-compact --save
```

### NodeJs import and setup

```js
var xtype = require('xtypejs');
var xtypejsCompactNameScheme = require('xtypejs-name-scheme-compact');

// Either: Simple setup

xtype.options.setNameScheme(xtypejsCompactNameScheme);

// Or: To first register name scheme internally for later
// reference by name, for switching between name schemes:

xtype.ext.registerNameScheme('compact', xtypejsCompactNameScheme);
xtype.options.setNameScheme('compact');

// Scheme is now active here
```

### HTML script tag import and setup

```html
<!--
    Include name scheme script after xtypejs script 
    to automatically register the name scheme into
    xtypejs with the default scheme name: 'compact'
-->

<script src="path/to/xtype.js"></script>
<script src="path/to/xtypejs-name-scheme-compact.js"></script>

<script>
    xtype.options.setNameScheme('compact');
    // Scheme is now active here
</script>
```

### Usage

For general documentation on using custom name schemes, see:

* [Registering a custom name scheme](https://xtype.js.org/guide/registering_custom_name_scheme)
* [Switching back to the default name scheme](https://xtype.js.org/guide/switching_back_to_default_name_scheme)
* [registerNameScheme method](https://xtype.js.org/api/registerNameScheme)
* [setNameScheme method](https://xtype.js.org/api/setNameScheme)

### Type names in scheme
---

Type Default Name    | Name in Scheme
:------------------  | :------------
`null`               | `null`
`undefined`          | `undef`
`nan`                | `nan`
`symbol`             | `symb`
`function`           | `func`
`date`               | `date`
`error`              | `err`
`regexp`             | `regex`
`boolean`            | `bool`
`true`               | `true`
`false`              | `false`
`string`             | `str`
`whitespace`         | `str_`
`single_char_string` | `str1`
`multi_char_string`  | `str2+`
`empty_string`       | `str0`
`blank_string`       | `str0_`
`non_empty_string`   | `-str0`
`non_blank_string`   | `-str0_`
`number`             | `num`
`positive_number`    | `num+`
`negative_number`    | `num-`
`zero`               | `num0`
`non_positive_number`| `-num+`
`non_negative_number`| `-num-`
`non_zero_number`    | `-num0`
`integer`            | `int`
`positive_integer`   | `int+`
`negative_integer`   | `int-`
`float`              | `float`
`positive_float`     | `float+`
`negative_float`     | `float-`
`infinite_number`    | `inf`
`positive_infinity`  | `inf+`
`negative_infinity`  | `inf-`
`non_infinite_number`| `-inf`
`array`              | `arr`
`empty_array`        | `arr0`
`single_elem_array`  | `arr1`
`multi_elem_array`   | `arr2+`
`non_empty_array`    | `-arr0`
`object`             | `obj`
`empty_object`       | `obj0`
`single_prop_object` | `obj1`
`multi_prop_object`  | `obj2+`
`non_empty_object`   | `-obj0`
`primitive`          | `prim`
`nothing`            | `nil`
`any`                | `any`
`none`               | `none`

---
_Source: https://npm.io/package/xtypejs-name-scheme-compact · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._