@skyra/tags

An advanced tags system for custom commands

---

Table of Contents

• @skyra/tags
  • Description
  • Features
  • Installation and Usage
    • Package managers
      • Usage
    • Browser build
      • Usage
  • API Documentation
  • Buy us some doughnuts
  • Contributors ✨

Description

Advanced custom commmands system for Skyra discord bot.

Features

• Written in TypeScript.
• @skyra/tags is an advanced tags system for custom commands supporting UTF-16 and a Lexer with O(n) time complexity.
• Supports both NodeJS and Browsers by providing CommonJS, ES Module and UMD bundles.

Installation and Usage

Package managers

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

Usage

const { parse } = require('@skyra/tags');

import { parse } from '@skyra/tags';

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/tags"></script>

Usage

The UMD module is exported as SkyraTags:

<script>
	SkyraTags.parse('Hello {{user}}!');
</script>

API Documentation

For the full API documentation please refer to the TypeDoc generated documentation.

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		Click Here
PayPal		Click Here
BitCoin		3JNzCHMTFtxYFWBnVtDM9Tt34zFbKvdwco
Ethereum		0xcB5EDB76Bc9E389514F905D9680589004C00190c
Litecoin		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!