Skip to content

encoding used by Skedify to create conflict-free URL fragments

License

Notifications You must be signed in to change notification settings

skedify/skedify-uri-encoding

Repository files navigation

Skedify URI-Encoding

Release: GitHub license npm Build Status

Development: Build Status GitHub issues Commitizen friendly

Installation

npm install skedify-uri-encoding

Usage

With ES Modules:

import { encodeURIParameters, decodeURIParameters } from 'skedify-uri-encoding';

const encoded = encodeURIParameters({ attribute: 'value' });
console.log({ encoded });
const decoded = decodeURIParameters(encoded);
console.log({ decoded });

With CommonJS:

const { encodeURIParameters, decodeURIParameters } = require('skedify-uri-encoding');

const encoded = encodeURIParameters({ attribute: 'value' });
console.log({ encoded });
const decoded = decodeURIParameters(encoded);
console.log({ decoded });

Stack

This repostiory uses TSDX for development.

Contributing

Use npm run commit when you want to commit a change.

Releases

This project uses GitHub actions and semantic-release for creating releases.

Release Candidates

To make a (temporary) release candidate, push a new tag. The version in package.json will be the same as the tagname without the v prefix.

git tag v5.0.0-rc.1 && git push origin v5.0.0-rc.1

Final Releases

Since semantic-release is currently configured to run on any push'es to master, creating and merging a GitHub Pull Request into master will trigger a new release automatically.

Typically we do this via a temporary release/next or release/SKED-XXXX branch and creating a PR via GitHub UI.