snackabra

Snackabra Library (aka "jslib")

If you would like to contribute or help out with the snackabra project, please feel free to reach out to us at [e-mail] or [e-mail]

Snackabra is licensed under GPL-v3, see GPL v3 license file for details.

About

For documentation see:

• https://snackabra.readthedocs.io (latest)
• https://snackabra.io (archive of version 0.4.3)

Source and related projects: https://github.com/snackabra

Build

(Note: we use yarn 3.6.0 or later)

# first time:
yarn install

# build and watch:
yarn start

Note the main jslib file is in ''jslib/src/snackabra.ts''. It gets built into ''jslib/build'' and copied into ''./dist''.

Usage in browsers

Directly in your html:

  <!-- this will bring the minified version to "SB" -->
  <script type="module" src="https://unpkg.com/snackabra"></script>

  <!-- or dynamic import -->
  <script>
    import('https://unpkg.com/snackabra').then((sb) => {
      // do something with sb ...
    });

You can also access the loaded functions globally, e.g. window.SB.str2ab('hello').

From a local copy:

  <script type="module" src="snackabra.js"></script>

Usage in Node

This is dated, we do not prioritize node. Deno is the future.

Install:

npm install snackabra -g

A couple of ways to load ES module version in nodejs:

// method 1:
import * as sb from 'snackabra';
console.log(sb.str2ab('hello'));

// method 2 (the default export)
import Snackabra from 'snackabra';
console.log(Snackabra.str2ab('hello'));

// method 3
const sb = await import('snackabra');
console.log(sb.str2ab('hello'));

// method 4
import {str2ab} from 'snackabra';
console.log(str2ab('hello'));

Development and Publishing

# first time around remember to:
yarn install

# build components
yarn pack

# if needed
yarn login

# if you have credentials
yarn publish

Package should get updated at https://www.npmjs.com/package/snackabra

LICENSE

Copyright (c) 2016-2023 Magnusson Institute, All Rights Reserved.

"Snackabra" is a registered trademark

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice, the above trademark notice, and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

See GPL v3 license file for details.