Skip to content

Latest commit

 

History

History
72 lines (51 loc) · 2.7 KB

README.md

File metadata and controls

72 lines (51 loc) · 2.7 KB
Raw

Croct
JSON
Strong JSON typing for TypeScript

Version Build

📦 Releases · 🐞 Report Bug · ✨ Request Feature

Introduction

This library provides types for representing arbitrary data types, both strictly and loosely (JSON-compatible).

Installation

We recommend using NPM to install the package:

npm install @croct/json

Overview

The types in this library include:

  • Types for representing valid JSON values
  • Types for representing values that can be safely serialized to JSON using JSON.stringify()
  • An interface for classes that can serialize to JSON

See the source code for more information.

Contributing

Contributions to the package are always welcome!

  • Report any bugs or issues on the issue tracker.
  • For major changes, please open an issue first to discuss what you would like to change.
  • Please make sure to update tests as appropriate.

Building

Before building the project, the dependencies must be installed:

npm install

The following command builds the library:

npm run build

License

Copyright © 2015-2021 Croct Limited, All Rights Reserved.

All information contained herein is, and remains the property of Croct Limited. The intellectual, design and technical concepts contained herein are proprietary to Croct Limited s and may be covered by U.S. and Foreign Patents, patents in process, and are protected by trade secret or copyright law. Dissemination of this information or reproduction of this material is strictly forbidden unless prior written permission is obtained from Croct Limited.