Skip to content

Latest commit

 

History

History
115 lines (83 loc) · 4.87 KB

README.md

File metadata and controls

115 lines (83 loc) · 4.87 KB

@skyra/char

GitHub codecov

npm npm bundle size minified (scoped) npm bundle size minzipped (scoped)

Table of Contents

About

  • @skyra/char is a character utility library with ASCII, Latin-1, and UTF-8 support based on .NET's char struct, all credits to the .NET community and thanks to the Discord C# Community for helping us understand the low-level unsafe logic.
  • Supports both NodeJS and Browsers by providing CommonJS, ES Module and UMD bundles.

Installation and Usage

Package managers

yarn add @skyra/char
# or npm install @skyra/char

Usage

const { fromCode } = require('@skyra/char');
import { fromCode } from '@skyra/char';

Browser build

If you want to use the browser build you can pull it directly via unpkg. Note that when using a Framework such as React, Vue or Angular we recommend you refer to the package managers section.

<script src="https://unpkg.com/@skyra/char"></script>

Usage

The UMD module is exported as SkyraChar:

<script>
	SkyraChar.fromCode();
</script>

Meta

License

Copyright © 2020, Skyra Project. Released under the MIT License.

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request!

Buy us some doughnuts

Skyra Project is open source and always will be, even if we don't get donations. That said, we know there are amazing people who may still want to donate just to show their appreciation. Thanks you very much in advance!

We accept donations through Patreon, BitCoin, Ethereum, and Litecoin. You can use the buttons below to donate through your method of choice.

Donate With QR Address
Patreon PatreonImage Click Here
PayPal PayPalImage Click Here
BitCoin BitcoinImage 3JNzCHMTFtxYFWBnVtDM9Tt34zFbKvdwco
Ethereum EthereumImage 0xcB5EDB76Bc9E389514F905D9680589004C00190c
Litecoin LitecoinImage MNVT1keYGMfGp7vWmcYjCS8ntU8LNvjnqM

Contributors

Please make sure to read the Contributing Guide before making a pull request.

Thank you to all the people who already contributed to Skyra Project!