qtail.js

usage

fast start

using cdn?

npm ins qtail-js
yarn add qtail-js
pnpm add qtail-js

import qtail from 'qtail-js'; // or const qtail = require('qtail-js').default;
const Qtail = new qtail(nick: string, tail: string, compatible?: boolean);
console.log(Qtail.generate()); // 'nick⁧tail⁦'

cdn

import qtail from 'https://cdn.jsdelivr.net/npm/qtail-js@latest/+esm';

upgrade from 1.x

-import qtail from 'qtail-js'; // or const qtail = require('qtail-js');
+import qtail from 'qtail-js'; // or const qtail = require('qtail-js').default;
-const result = qtail.generate(nick, tail);
+const Qtail = new qtail(nick, tail, true);
+const result = Qtail.generate();

detailed usage

available functions

/**
 * update config
 * @param nick nickname
 * @param tail tail
 * @param compatible compatible mode (use legacy unicode) (optional, default: false)
 */
qtail.update(nick: string, tail: string, compatible?: boolean): void;
qtail.upd(nick: string, tail: string, compatible?: boolean): void;

/**
 * generate nickname with tail
 * @returns nickname with tail
 */
qtail.generate(): string;
qtail.gen(): string;