# @larner.dev/perk-db

> A light weight database connector + ORM built on top of knex.

Latest version **1.0.0** (published 2022-10-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install @larner.dev/perk-db
pnpm add @larner.dev/perk-db
yarn add @larner.dev/perk-db
bun add @larner.dev/perk-db
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2022-10-27 |
| First published | 2022-10-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 42.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Aaron Larner |
| Maintainers | alarner |

## Links

- npm: https://www.npmjs.com/package/@larner.dev/perk-db
- Repository: https://github.com/larner-dev/perk-db
- Homepage: https://github.com/larner-dev/perk-db#readme
- Issues: https://github.com/larner-dev/perk-db/issues
- npm.io page: https://npm.io/package/@larner.dev/perk-db

## Dependencies (2)

- [@types/node](https://npm.io/package/@types/node.md) 18.11.5
- [@larner.dev/perk-response-codes](https://npm.io/package/@larner.dev/perk-response-codes.md) 1.0.0

## Recent versions

- 1.0.0 (latest) — 2022-10-27

## README

# Perk

```ts
import { server } from "perk";

server({
	rootDirectory: __dirname,
	routes: {
		directory: "./routes",
		excludeRegex: ".*\\.test\\.ts$",
	},
	server: {
		url: "https://api.mywebsite.com",
		port: 3001,
		cors: {},
	},
})
	.then(() => {
		console.log(`Server started on port 3001`);
	})
	.catch((error: Error) => {
		console.error("The server couldn't start up...");
		console.error(error.message);
	});

process.once("SIGUSR2", async function () {
	process.kill(process.pid, "SIGUSR2");
});
```

---
_Source: https://npm.io/package/@larner.dev/perk-db · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._