Getting Started
NOT FOR PRODUCTION?
The SecLoad package has been released VERY recently and documentation may be incomplete...
You can use this module for production, but error handling has not came out yet. Use this with caution.
Prerequisites
- NodeJS (Latest version/LTS recommended)
- NPM (8.19.4 recommended, depends on Node version) or any other package manager such as Yarn, PNPM, or Bun
- Internet access, obviously.
Installation
To use SecLoad's API, first install the secload
package.
- NPM
- Yarn
- PNPM
- Bun
npm install secload
yarn add secload
pnpm add secload
bun add secload
API Keys
SecLoad's Node module has a generateAPIKey function, you can use that to generate an API key. If you don't want to, you can generate an API key from Secloads's Swagger Docs
- CommonJS
- ESM
- TypeScript
Create a file named generateAPIKey.js
generateAPIKey.js
require('secload').generateAPIKey(50).then((key) => console.log(key))
Create a file named generateAPIKey.js
(or generateAPIKey.mjs
)
generateAPIKey.js
import {generateAPIKey} from "secload"
generateAPIKey(50).then((key) => console.log(key))
Create a file named generateAPIKey.ts
generateAPIKey.ts
import secload from "secload"
secload.generateAPIKey(50).then((key) => console.log(key))