Security News
The Push to Ban Ransom Payments Is Gaining Momentum
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
nukak
Advanced tools
Readme
nukak is the smart ORM for TypeScript and modern JavaScript, is designed to be fast, safe, and easy to integrate into any application. It draws inspiration from TypeORM and Mongo driver.
nukak can run in Node.js, Browser, Cordova, PhoneGap, Ionic, React Native, NativeScript, Expo, and Electron platforms.
nukak provides a consistent API for a wide variety of databases including PostgreSQL, MySQL, SQLite and MongoDB.
100%
valid JSON
allowing the queries to be transported across platforms with ease.TypeScript
so it auto-completes, validates, and infers the appropriate operators on any level of the queries, including the relations and their fields.OOP
(Object Oriented Programming) and FP
(Functional Programming).transactions
for flexibility, and connection pooling
for scalability.ESM
is natively supported by Node.js 12 and later.
Install the core package:
npm install nukak --save
Install one of the specific adapters for your database:
Database | Driver | Nukak Adapter |
---|---|---|
MySQL | mysql2 | nukak-mysql |
MariaDB | mariadb | nukak-maria |
SQLite | sqlite sqlite3 | nukak-sqlite |
PostgreSQL | pg | nukak-postgres |
MongoDB | mongodb | nukak-mongo (alpha) |
For example, for Postgres
:
npm install pg nukak-postgres --save
Additionally, your tsconfig.json
may need the following flags:
"target": "es2020",
"experimentalDecorators": true,
"emitDecoratorMetadata": true
A default querier-pool can be set in any of the bootstrap files of your app (e.g. in the server.ts
).
import { setQuerierPool } from 'nukak';
import { PgQuerierPool } from 'nukak-postgres';
export const querierPool = new PgQuerierPool(
{
host: 'localhost',
user: 'theUser',
password: 'thePassword',
database: 'theDatabase',
},
// optionally, a logger can be passed to log the generated SQL queries
{ logger: console.log }
);
// the default querier pool that `nukak` will use
setQuerierPool(querierPool);
Take any dump class (aka DTO) and annotate it with the decorators from nukak/entity
.
import { v4 as uuidv4 } from 'uuid';
import { Id, Field, Entity } from 'nukak/entity';
/**
* any class can be annotated with this decorator to make it works as
* an entity.
*/
@Entity()
export class User {
/**
* an entity should specify an ID Field, its name and type are automatically detected.
* the `onInsert` property can be used to specify a custom mechanism for
* auto-generating the primary-key's value when inserting.
*/
@Id({ onInsert: uuidv4 })
id?: string;
/**
* the properties of the class can be annotated with this decorator so they
* are interpreted as a column, its name and type are automatically detected.
*/
@Field()
name?: string;
@Field()
email?: string;
@Field()
password?: string;
}
import { getQuerier } from 'nukak';
import { User } from './shared/models/index.js';
async function findLastUsers(limit = 10) {
const querier = await getQuerier();
const users = await querier.findMany(
User,
{
$sort: { createdAt: -1 },
$limit: limit,
},
['id', 'name', 'email']
);
await querier.release();
return users;
}
async function createUser(body: User) {
const querier = await getQuerier();
const id = await querier.insertOne(User, body);
await querier.release();
return id;
}
Learn more about nukak
at its website https://nukak.org
FAQs
flexible and efficient ORM, with declarative JSON syntax and smart type-safety
We found that nukak demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
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.
Security News
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
Application Security
New SEC disclosure rules aim to enforce timely cyber incident reporting, but fear of job loss and inadequate resources lead to significant underreporting.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).