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

@axolo/query2sequelize

v0.1.1

Published

parse query as sequelize

Downloads

132

Readme

query2sequelize

Parse query as Sequelize.

install

npm i @axolo/query2sequelize

usage

const query2sequelize = require('@axolo/query2sequelize')

const result = query2sequelize({
  price: '>99',
  name: 'Da,Fang',
  title: '%Sample%',
  access_token: 'secret',
  additionalField: 'value',
  _include: 'users,orders',
  _order: 'createdAt,!updatedAt',
  _offset: 10,
  _limit: 20
})

result

{
  access_token: 'secret',
  include: ['users', 'orders'],
  where: {
    price: { [Sequelize.Op.gt]: '99' },
    name: { [Sequelize.Op.in]: ['Da', 'Fang'] },
    title: { [Sequelize.Op.like]: '%Sample%' },
    additionalField: 'value'
  },
  order: [
    ['createdAt', 'asc'],
    ['updatedAt', 'desc']
  ],
  offset: 10,
  limit: 20
}

api

query2sequelize(query, [config])

query

include

| params | sql | example | description | | :--------: | :---------------: | ------------------------ | ---------------------- | | _include | LEFT OUTER JOIN | _include=user,newsTags | join user and newsTags |

news hasOne user, hasMany tags

-- curl '/news?_include=user,tags'
SELECT * FROM news
LEFT OUTER JOIN `user` ON `user`.id = news.userId
LEFT OUTER JOIN newsTag ON newsTag.newsId = news.id;

where

| params | sql | example | description | | :----: | :-----------: | ---------------------------- | ---------------------------- | | | = | price=99 | price = 99 | | > | > | price=>99 | price > 99 | | < | < | price=<100 | price < 100 | | ! | != | price=!99 | price != 99 | | !< | >= | price=!<100 | price >= 100 | | !> | <= | price=!>99 | price <= 100 | | % | LIKE | title=Hangzhou% | starts with 'Hangzhou' | | , | IN | name=zhangsan,lisi | name in ['zhangsan', 'lisi'] | | ~ | BETWEEN AND | date=2023-07-01~2023-08-01 | date in july of 2023 |

news of October 2024

-- curl '/news?createdAt=2024-10-01~2024-11-01'
SELECT * FROM news
WHERE createdAt BETWEEN '2024-10-01' AND '2024-11-01';

order

| params | sql | example | description | | :------: | :--------: | ------------------------ | ------------------------ | | _order | ORDER BY | _order=updatedAt | order by updatedAt asc | | ! | DESC | _order=!updatedAt | order by updatedAt desc | | , | , | _order=sort,!updatedAt | sort asc, updatedAt desc |

get news with top and updatedAt desc

-- curl '/news?_order=top,!updatedAt'
SELECT * FROM news
ORDER BY `top` ASC, updatedAt DESC;

limit

| params | sql | example | description | | :-------: | :-----: | ------------ | -------------------- | | _offset | LIMIT | _offset=10 | record start from 10 | | _limit | LIMIT | _limit=20 | limit 20 records |

news of page 2

-- curl '/news?_offset=10&_limit=20'
SELECT * FROM news
LIMIT 10, 20;

config

| params | type | default | description | | -------------- | -------- | ------------------ | --------------------------- | | Sequelize | Object | config.Sequelize | Sequelize instance | | offset | Number | 0 | default offset | | limit | Number | 1000 | default limit | | reservedKeys | Array | ['access_token'] | keys not be parsed to where |

Yueming Fang 2024-12-05