npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@dialexa/knex-plus

v1.2.0

Published

A lightweight repository library powered by knex

Downloads

8

Readme

Knex+

NPM Version Build Status Coverage Status

This library is meant to serve as an extremely lightweight layer on top of Knex for software developer quality of life purposes. It's not meant to be extensive, support associations (belongs to, has many), etc. If you are looking for something like that, please refer to some of the following:

Basic Usage

The repository class can be initialized like so:

import { Repository } from '@dialexa/knex-plus';

const repository = new Repository(knex, 'users');

The constructor takes a knex object (which can be a transaction) and a table name.

The repository method signatures can be found here

Examples

import { Repository } from '@dialexa/knex-plus';
// Initialize the repository
const repository = new Repository(knex, 'users');
// Create a record
await repository.create({ email: '[email protected]', password: 'password' });
// Fetch a record
const user = await repository.findBy({ email: '[email protected]' });
// Update a record
await repository.update({ id: user.id }, { password: 'swordfish' });
// Destroy a record
await repository.destroy({ id: user.id });

Additional

Type Checking

The repository can be initialized with an interface if using typescript for type checking on returned records like so:

import { Repository } from '@dialexa/knex-plus';

interface IUser {
  id?: string,
  email: string,
  createdAt: Date,
  updatedAt?: Date
}

const repository = new Repository<IUser>(knex, 'users');

Auditability

This library includes a class AuditableRepository that will automatically update an updatedAt column if desired. The class constructor is identical to Repository and can be initialized like so:

import { AuditableRepository } from '@dialexa/knex-plus';

const repository = new AuditableRepository(knex, 'users');

If you want to customize the updatedAt column, you can do so:

import { AuditableRepository } from '@dialexa/knex-plus';

const repository = new AuditableRepository(knex, 'users', 'modifiedAt');