ts-jackett-api v1.0.0

ts-jackett-api

Template to kickstart creating a Node.js module using TypeScript and VSCode

Inspired by node-module-boilerplate

Features

• Semantic Release
• Issue Templates
• GitHub Actions
• Codecov
• VSCode Launch Configurations
• TypeScript
• Husky
• Lint Staged
• Commitizen
• Jest
• ESLint
• Prettier

Getting started

Set up your repository

Click the "Use this template" button.

Alternatively, create a new directory and then run:

curl -fsSL https://github.com/ryansonshine/ts-jackett-api/archive/main.tar.gz | tar -xz --strip-components=1

Replace FULL_NAME, GITHUB_USER, and REPO_NAME in the script below with your own details to personalize your new package:

FULL_NAME="Marni"
GITHUB_USER="marnixah"
REPO_NAME="ts-jackett-api"
sed -i.mybak "s/\([\/\"]\)(ryansonshine)/$GITHUB_USER/g; s/ts-jackett-api\|ts-jackett-api/$REPO_NAME/g; s/Marni/$FULL_NAME/g" package.json package-lock.json README.md
rm *.mybak

Add NPM Token

Add your npm token to your GitHub repository secrets as NPM_TOKEN.

Add Codecov integration

Enable the Codecov GitHub App here.

Remove everything from here and above

ts-jackett-api

My awesome module

Install

npm install ts-jackett-api

Usage

import { myPackage } from 'ts-jackett-api';

myPackage('hello');
//=> 'hello from my package'

API

myPackage(input, options?)

input

Type: string

Lorem ipsum.

options

Type: object

postfix

Type: string Default: rainbows

Lorem ipsum.