🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
Book a DemoInstallSign in
Socket

@kcp/functions

Package Overview
Dependencies
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@kcp/functions

A basic plugin which adds reloadable functions to Klasa

1.0.0
latest
Source
npm
Version published
Weekly downloads
4
-20%
Maintainers
1
Weekly downloads
 
Created
Source

NPM version NPM downloads Install Size Build Status

NPM info

Functions

A simple Klasa plugin which adds reloadable functions to your Klasa Bot

How To Use

  • Install the plugin.
npm i @kcp/functions

# If you use yarn
yarn add @kcp/functions
  • Use @kcp/functions in your client.
const { Client } = require("klasa");
Client.use(require("@kcp/functions"));

new Client({ aliasFunctions: { returnMethod: "run", prefix: "funcs", enabled: true } }).login("Your Beautiful Token");

If you use TypeScript

import { Client } from 'klasa';
import { Client as FunctionsClient } from '@kcp/functions';

Client.use(FunctionsClient);

new Client({ aliasFunctions: { returnMethod: "run", prefix: "funcs", enabled: true } }).login("Your Beautiful Token");
  • Create a new function in your functions folder with the name you want to access later, for example test.js or test.ts.
const { Function } = require("@kcp/functions");

module.exports = class extends Function {
    run() {
        // Your Code Here
    }
}
  • Use these functions in your bot.
this.client.funcs.test();
  • ???... Enjoy!

Tips

  • To allow multiple functions in a file so you can do something like this.client.funcs.utils.toTitleCase(string) instead of using 1 file per function remove the returnMethod.

License

This project is under the MIT license.

FAQs

Package last updated on 17 Apr 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts