Giter Club home page Giter Club logo

idb-query's Introduction

Simple TypeScript IDB wrapper

Examples:

Create an Article entity

import { createIDBEntity } from "idb-orm";
// create your own database
const db = createDb();

interface IArticle {
  author: string;
  string: string;
  text: string;
  tags: string[];
}
const Student = createIDBEntity<IStudent, "id">(
  db, // need to provide database handle
  "students", // store name
  "id" // keyPath
);

New entity

Student.create({
    author: "John Smith";
    title: "Ut aliquet facilisis turpis",
    text: ` Amet bibendum euismod, leo diam interdum ligula, eu scelerisque sem
              purus in tellus.

    Lorem ipsum dolor sit amet, consectetuer adipiscing elit. In sit amet nunc id
    quam porta varius. Ut aliquet facilisis turpis. Etiam pellentesque quam et
    erat. Praesent suscipit justo.
    `;
    created: new Date(),
    tags: ["stuff", "life", "cats"],
})

Queries

// Get all articles that
Student.query()
  .byIndex("created")
  // had been posted in the range from 1st september of 2013
  .from(new Date("2013-09-01"))
  // to 1st september of 2014
  .to(new Date("2014-09-01"))
  // that were about cars
  .filter((art) => art.tags.find("cars"))
  // then group by month
  .groupBy(
    (art) =>
      new Date(
        art.created.getFullYear(), //
        art.created.getMonth()
      )
  )
  // take only the first 10 months
  .take(10)
  .all();

More usage examples can be found in the tests directory.

idb-query's People

Contributors

comonadd avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.