# jsonotron-core-field-types

> A library of core field type definitions for the Jsonotron system.

Latest version **7.4.3** (published 2020-09-15) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install jsonotron-core-field-types
pnpm add jsonotron-core-field-types
yarn add jsonotron-core-field-types
bun add jsonotron-core-field-types
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 7.4.3 |
| Published | 2020-09-15 |
| First published | 2020-09-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 104.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Karl Hulme |
| Maintainers | karlhulme |

## Links

- npm: https://www.npmjs.com/package/jsonotron-core-field-types
- Repository: https://github.com/karlhulme/jsonotron-core-field-types
- Homepage: https://github.com/karlhulme/jsonotron-core-field-types#readme
- Issues: https://github.com/karlhulme/jsonotron-core-field-types/issues
- npm.io page: https://npm.io/package/jsonotron-core-field-types

## Recent versions

- 7.4.3 (latest) — 2020-09-15
- 7.4.2 — 2020-09-06
- 7.4.1 — 2020-09-05
- 7.4.0 — 2020-09-05
- 7.3.0 — 2020-09-03
- 7.2.1 — 2020-09-03
- 7.2.0 — 2020-09-03
- 7.1.0 — 2020-09-02
- 7.0.0 — 2020-09-01
- 6.0.1 — 2020-09-01
- 6.0.0 — 2020-09-01

## README

# Jsonotron Core Field Types

A library of enum types and schema types for the Jsonotron system.

![](https://github.com/karlhulme/jsonotron-core-field-types/workflows/CD/badge.svg)
[![npm](https://img.shields.io/npm/v/jsonotron-core-field-types.svg)](https://www.npmjs.com/package/jsonotron-core-field-types)
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

This library is intended for use with the [Jsonotron](https://github.com/karlhulme/jsonotron) system.

Available types:

Enum Type Name | Description
---|---
boolean | The values true and false.
callingCode | International country dialing codes.
countryCode | International country codes.
currencyCode | International currency codes.
dayOfWeek | The days of the week.
languageCode | International language codes.
monthOfYear | The months of the year.
timeZone | International time zones.
yesNo | The values yes and no.

Schema Type Name | Description
---|---
address | An international address.
date | A date in the form YYYY-MM-DD.
dateTimeLocal | A date time in the form YYYY-MM-DDTHH:mm:ss+xx:xx.  There must be a timezone component.
dateTimeUtc | A date time in the form YYYY-MM-DDTHH:mm:ssZ.  There is no timezone component required.
emailAddress | An email address.
float | As per name.
geoJsonPoint | A point on Earth.
geoJsonPolygon | A region on Earth.
hugeString | A string up to 4000 characters.
integer | As per name.
ipv4 | An IP address in IP v4 format.
ipv6 | An IP address is iP v6 format.
jsonPointer | A pointer into a json document.
longString | A string up to 250 characters.
mediumString | A string up to 50 characters.
money | An amount of money.
negativeFloat | As per name.
negativeFloatOrZero | As per name.
negativeInteger | As per name.
negativeIntegerOrZero | As per name.
object | Any object.  It's better not to use this.
paymentCardNo | A credit or debit card number.
positiveFloat | As per name.
positiveFloatOrZero | As per name.
positiveInteger | As per name.
positiveIntegerOrZero | As per name.
shortString | A string up to 20 characters.
string | A string.
telephoneNo | An international telephone number.
time | A time in the format HH:mm:ss.
timestamp | A unix timestamp.
uuid | A unique identifier.
webAddress | A url that is prefixed with either https or https.
what3words | The what 3 words addressing system.

## Installation

```bash
npm install jsonotron-core-field-types --save
```

## Development

Code base adheres to the rules chosen by https://standardjs.com/.  Code is formatted with 2 spaces.

Tests are written using Jest with 100% coverage.

```javascript
npm test
```

## Continuous Deployment

Any pushes or pull-requests on non-master branches will trigger the test runner.
Any pushes to master will cause the library to be re-published.

---
_Source: https://npm.io/package/jsonotron-core-field-types · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._