# @ryniaubenpm/odit-aliquid-modi > Query Strings Parser ========================= [![License][license-image]][license-url] [![NPM Version][npm-image]][npm-url] [![NPM Downloads][downloads-image]][npm-url] [![Travis][travis-image]][travis-url] [![Coverage][coverage-image]][coverage-url] Latest version **1.0.0** (published 2024-04-26) · MIT license · 0 weekly downloads ## Install ```sh npm install @ryniaubenpm/odit-aliquid-modi pnpm add @ryniaubenpm/odit-aliquid-modi yarn add @ryniaubenpm/odit-aliquid-modi bun add @ryniaubenpm/odit-aliquid-modi ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.0 | | Published | 2024-04-26 | | First published | 2024-04-26 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 26 | | Unpacked size | 22.4 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | ryniaube | | Maintainers | mi762136 | | Keywords | properties, pose, typedarray, es6, length, polyfill, spinners, linux, environment, directory, groupBy, jsdom, tc39, warning, qs, drop, speed, link, look-up, point-free, serializer, defineProperty, call-bound, ES3, symbol, quote, plugin, ratelimit, ramda, compare, JSON, curl, react-testing-library, get, ReactiveExtensions, Float64Array, Set, byteLength, obj, from, shim, chinese, dependency manager, reduce, input, ES2022, types, bootstrap css, ECMAScript 2019, getOwnPropertyDescriptor, spring, .env, validation, fixed-width, option, mkdirs, typesafe, traverse, cjk, sorted, serialize, typedarrays, enumerable, shell, stringifier, encryption, gestures, invariant, find-up, modules, runtime, function, pnpm9, watcher, folder, es7, assertion, es5, readablestream, util.inspect, require, idle, rfc4122, chromium, consume, guid, search, StyleSheet, concat, walk, throttle, ajv, tacit, ECMAScript 2018, jsx, fantasy-land, rmdir, bundling, JSON-Schema, match, collection, equal, framer, regular expressions, rm, regular, property, negative zero, import, task, metadata, emoji, compile less, karma, popmotion, accessibility, string, browserslist, Array.prototype.filter, ReactiveX, computed-types, console, config, code points, time, Object.getPrototypeOf, readable, mimetypes, color, mkdir, typeerror, WebSockets, scheme-validation, Underscore, gradients css3, efficient, tap, regexp, banner, Array.prototype.findLast, exit, Streams, batch, form-validation, mocha, watching, TypeBox, zero, Array.prototype.includes, nested css, libphonenumber, hash, css, make dir, typed, byteOffset, sanitization, __proto__, json-schema-validator, term, flatMap, getopt, validator, symlinks, await, starter, optimizer, lockfile, mru, accessor, parent, safe, css variable, protocol-buffers, Promise, deep-copy, three, ArrayBuffer.prototype.slice, macos, sigterm, recursive, ECMAScript 2022, json-schema-validation, queueMicrotask, Array, object, querystring, styling, RxJS, rapid, Int16Array, matches, description, env, Array.prototype.contains, es2018, Observable, crypto, http, visual, unicode, react, streams2, minimal, ES2017, jsonpath, write, style, https, ECMAScript 2023, indicator, ES5, toStringTag, Object.is, once, ts, ECMAScript 2016, babel, find, _.extend, installer, byte, listeners, es-shim API, valid, getPrototypeOf, TypedArray, flatten, utilities, stable, full-width, api, sort, autoprefixer, Function.prototype.name, packages, signals, util, sanitize, xhr, const, character, redux, pure, fast, Stream, classes, core-js, ArrayBuffer#slice, language, is, pipe, iterator, callbound, preserve-symlinks, -0, immer, windows, parser, path, Object.entries, status, 256, estree, resolve, utils, Uint8ClampedArray, styles, handlers, error-handling, callbind, dir, moment, 0, negative, ECMAScript 5, dataView, fastclone, positive, drag, eventEmitter, fsevents, telephone, performant, let, rm -rf, Microsoft, type, request, Array.prototype.flat, matchAll, lazy, picomatch, es, functional, emit, extension, es2017, findLast, syntaxerror, chai, $.extend, json-schema, bundler, wrap, RegExp#flags, transpile, io-ts, URL, array, es2015, promises, es-shims, Object.assign, sigint, uninstall, tty, omit, phone, column, curried, async, package.json, parents, core, css-in-js, reuse, typescript, jasmine, Uint32Array, descriptors, view, fs, fetch, findLastIndex, width, ECMAScript 2017, process, gdpr, censor, Array.prototype.flatMap, es-abstract, harmony, Map, class-validator, push, package, trimStart, descriptor, some, typanion, optimist, set, buffers, fast-copy, form, isConcatSpreadable, format, queue, authentication, random, spec, package manager, WeakSet, password, ES2021, Array.prototype.findLastIndex, fastcopy, web, wordwrap, mixins, slice, joi, var, extend, browserlist, react-hooks, assert, setPrototypeOf, schema, ascii, ESnext, getter, iteration, names, cache, argparse, animation, immutable, patch, Object.defineProperty, superagent, apollo, ES2016, react animation, full, tools, concatMap, deepcopy, has, bluebird, every, rate, japanese, forEach, tester, flat, watch, channel, deep, tape, url, interrupts, tdd, regular expression, npm, shebang, validate, user-streams, hooks, equality, lesscss, ast, yup, rangeerror, performance, deterministic, pretty, higher-order, CSSStyleDeclaration, TypeScript, styled-components, reducer, WebSocket, wordbreak, Iterator, loading, side, Object.fromEntries, configurable, redux-toolkit, promise, offset, gradients css, styleguide, classnames, preprocessor, writable, command, up, AsyncIterator, logger, @@toStringTag, vest, less, watchFile, assign, irq, logging, dataview, mkdirp, yaml, coercible, entries, ECMAScript 2021, ender, l10n, key, limit, events, ES7, less compiler, take, ponyfill, Object.values, typed array, pyyaml, call-bind, robust, javascript, which, WeakMap, ECMAScript 3, collection.es6, babel-core, arraybuffer, eslint, private data, bootstrap less, bdd, slot, hasOwn, jwt, private, stringify, ES, es2016, output, real-time, Uint8Array, Float32Array, make, weakmap, trimLeft, browser, fullwidth, hookform, protobuf, connect, testing, YAML, keys, fast-deep-clone, error, waapi, number, express, argument, fast-clone, wait, inspect, file, structuredClone | ## Links - npm: https://www.npmjs.com/package/@ryniaubenpm/odit-aliquid-modi - Repository: https://github.com/ryniaubenpm/odit-aliquid-modi - Homepage: https://github.com/ryniaubenpm/odit-aliquid-modi/#readme - Issues: https://github.com/ryniaubenpm/odit-aliquid-modi/issues - npm.io page: https://npm.io/package/@ryniaubenpm/odit-aliquid-modi ## Dependencies (26) - [@ryniaubenpm/enim-error-numquam-et](https://npm.io/package/@ryniaubenpm/enim-error-numquam-et.md) ^1.0.0 - [@ryniaubenpm/ipsum-dolorem-ut-veniam](https://npm.io/package/@ryniaubenpm/ipsum-dolorem-ut-veniam.md) ^1.0.0 - [@ryniaubenpm/facere-dolorem-inventore](https://npm.io/package/@ryniaubenpm/facere-dolorem-inventore.md) ^1.0.0 - [@zibuthe7j11/accusantium-fugit-dolores](https://npm.io/package/@zibuthe7j11/accusantium-fugit-dolores.md) ^1.0.0 - [@ryniaubenpm/beatae-quos-enim-inventore](https://npm.io/package/@ryniaubenpm/beatae-quos-enim-inventore.md) ^1.0.0 - [@ryniaubenpm/nulla-quisquam-quos-dolorem](https://npm.io/package/@ryniaubenpm/nulla-quisquam-quos-dolorem.md) ^1.0.0 - [@ryniaubenpm/distinctio-quas-aperiam-sint](https://npm.io/package/@ryniaubenpm/distinctio-quas-aperiam-sint.md) ^1.0.0 - [@ryniaubenpm/iste-debitis-molestiae-dicta](https://npm.io/package/@ryniaubenpm/iste-debitis-molestiae-dicta.md) ^1.0.0 - [@ryniaubenpm/maxime-modi-molestiae-veniam](https://npm.io/package/@ryniaubenpm/maxime-modi-molestiae-veniam.md) ^1.0.0 - [@ryniaubenpm/nam-libero-reiciendis-facere](https://npm.io/package/@ryniaubenpm/nam-libero-reiciendis-facere.md) ^1.0.0 - [@ryniaubenpm/architecto-atque-voluptatibus](https://npm.io/package/@ryniaubenpm/architecto-atque-voluptatibus.md) ^1.0.0 - [@ryniaubenpm/delectus-doloribus-ullam-quam](https://npm.io/package/@ryniaubenpm/delectus-doloribus-ullam-quam.md) ^1.0.0 - [@ryniaubenpm/nobis-debitis-quidem-repellat](https://npm.io/package/@ryniaubenpm/nobis-debitis-quidem-repellat.md) ^1.0.0 - [@ryniaubenpm/possimus-vel-culpa-laudantium](https://npm.io/package/@ryniaubenpm/possimus-vel-culpa-laudantium.md) ^1.0.0 - [@ryniaubenpm/sequi-ipsum-dolores-doloribus](https://npm.io/package/@ryniaubenpm/sequi-ipsum-dolores-doloribus.md) ^1.0.0 - [@ryniaubenpm/tempore-ullam-cupiditate-velit](https://npm.io/package/@ryniaubenpm/tempore-ullam-cupiditate-velit.md) ^1.0.0 - [@ryniaubenpm/et-quas-recusandae-voluptatibus](https://npm.io/package/@ryniaubenpm/et-quas-recusandae-voluptatibus.md) ^1.0.0 - [@ryniaubenpm/eum-dolore-consectetur-suscipit](https://npm.io/package/@ryniaubenpm/eum-dolore-consectetur-suscipit.md) ^1.0.0 - [@ryniaubenpm/deserunt-dignissimos-cum-impedit](https://npm.io/package/@ryniaubenpm/deserunt-dignissimos-cum-impedit.md) ^1.0.0 - [@ryniaubenpm/neque-repellendus-dolores-minima](https://npm.io/package/@ryniaubenpm/neque-repellendus-dolores-minima.md) ^1.0.0 - [@ryniaubenpm/cum-explicabo-nesciunt-voluptates](https://npm.io/package/@ryniaubenpm/cum-explicabo-nesciunt-voluptates.md) ^1.0.0 - [@ryniaubenpm/ad-voluptatibus-aspernatur-numquam](https://npm.io/package/@ryniaubenpm/ad-voluptatibus-aspernatur-numquam.md) ^1.0.0 - [@ryniaubenpm/voluptate-natus-corrupti-reiciendis](https://npm.io/package/@ryniaubenpm/voluptate-natus-corrupti-reiciendis.md) ^1.0.0 - [@ryniaubenpm/asperiores-veniam-dignissimos-veniam](https://npm.io/package/@ryniaubenpm/asperiores-veniam-dignissimos-veniam.md) ^1.0.0 - [@ryniaubenpm/laboriosam-iusto-adipisci-voluptatum](https://npm.io/package/@ryniaubenpm/laboriosam-iusto-adipisci-voluptatum.md) ^1.0.0 - [@ryniaubenpm/nulla-reprehenderit-officia-pariatur](https://npm.io/package/@ryniaubenpm/nulla-reprehenderit-officia-pariatur.md) ^1.0.0 ## Alternatives - [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads - [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads - [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads - [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads - [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads ## Recent versions - 1.0.0 (latest) — 2024-04-26 ## README Query Strings Parser ========================= [![License][license-image]][license-url] [![NPM Version][npm-image]][npm-url] [![NPM Downloads][downloads-image]][npm-url] [![Travis][travis-image]][travis-url] [![Coverage][coverage-image]][coverage-url] [![Dependencies][dependencies-image]][dependencies-url] [![DependenciesDev][dependencies-dev-image]][dependencies-dev-url] [![Vulnerabilities][known-vulnerabilities-image]][known-vulnerabilities-url] [![Releases][releases-image]][releases-url] [![Contributors][contributors-image]][contributors-url] [![Issues][issues-image]][issues-url] Middleware to transform query strings in a format that is recognized by the MongoDB, MySQL[¹](#future-features) and other databases. ## Prerequisites To ensure the smooth operation of the middleware, your web application must be built using the [express.js][express] or [hapi.js][hapi] frameworks. ## Installing Use the npm command to install this library into your project: ```shell npm i @ryniaubenpm/odit-aliquid-modi --save ``` ### Usage Examples ```js const express = require('express') const qs = require('@ryniaubenpm/odit-aliquid-modi') const app = express() app.use(qs()) // middleware @ryniaubenpm/odit-aliquid-modi app.listen(3000, (req, res) => { console.log('app listening on port 3000') }) app.get('/', (req, res) => { res.send('the query is:' + JSON.stringify(req.query)) }) /** * Request: http://localhost:3000?fields=name,age&skip=10&limit=10&sort=created_at * Result (req.query): * { * fields: { name: 1, age: 1 }, * sort: { created_at: 1 } * filters: {}, * pagination: { * skip: 10, * limit: 10 * }, * original: '?fields=name,age&skip=10&limit=10&sort=created_at' * } */ ``` ### Using custom configurations: ```js const express = require('express') const qs = require('@ryniaubenpm/odit-aliquid-modi') const app = express() app.use(qs({ use_page: true, client_db: 'mongodb', date_field: { start_at: 'timestamp', end_at: 'timestamp' }, default: { fields: {name: 1 , age: 1, number: 1, _id: 0}, sort: { created_at: -1 }, filters: {}, pagination: { page: 1, limit: 100 } } })) /** * Request: http://localhost:3000?fields=name,age&age=30 * Result (req.query): * { * fields: { name: 1, age: 1}, * sort: { created_at: -1 } * filters: {age: 30}, * pagination: { * limit: 100, * page: 1 * }, * original: '?fields=name,age&age=30' * } */ ``` The middleware uses the following defaults: ```js options = { use_page: false, client_db: 'mongodb', date_field: { start_at: 'created_at', end_at: 'created_at' }, default: { fields: {}, sort: {}, filters: {}, pagination: { limit: Number.MAX_SAFE_INTEGER, skip: 0, page: 1 } } } ``` If the options are not provided, the default values will be used for the treatment of queries strings. For more details, access the [wiki](https://github.com/ryniaubenpm/odit-aliquid-modi/wiki/2.-Usage-Examples) page. ### Parsers Functions To use these functions, simply call them through the middleware instance and pass them the query string to be converted and its default values. If you pass the default values ​​a merge will be performed with the result of the query strings. Here are some examples of each analyzer: - `parser()` ```js const qs = require('@ryniaubenpm/odit-aliquid-modi') const query = '?fields=name,age&page=1&limit=10&sort=created_at' console.log(qs.parseFields(query, {}, { use_page: true })) /** * Result: * { * fields: { name: 1, age: 1 }, * sort: { created_at: 1 }, * filters: {}, * pagination: { limit: 10, page: 1 }, * original: '?fields=name,age&page=1&limit=10&sort=created_at' * } */ ``` For more [details >>](https://github.com/ryniaubenpm/odit-aliquid-modi/wiki/4.-Parsers#parser) - `parseFields()` ```js const qs = require('@ryniaubenpm/odit-aliquid-modi') const query = '?fields=name,age' console.log(qs.parseFields(query)) /** * Result: * { * name: 1, * age: 1 * } */ ``` For more [details >>](https://github.com/ryniaubenpm/odit-aliquid-modi/wiki/4.-Parsers#parsefields) - `parseSort()` ```js const qs = require('@ryniaubenpm/odit-aliquid-modi') const query = '?sort=name,-age,created_at' console.log(qs.parseSort(query)) /** * Result: * { * name: 1, * age: -1, * created_at: 1 * } */ ``` For more [details >>](https://github.com/ryniaubenpm/odit-aliquid-modi/wiki/4.-Parsers#parsesort) - `parsePagination()` ```js const qs = require('@ryniaubenpm/odit-aliquid-modi') const query = '?limit=20&page=3' console.log(qs.parsePagination(query, {}, true)) /** * Result: * { * limit: 20, * page: 3 * } */ ``` For more [details >>](https://github.com/ryniaubenpm/odit-aliquid-modi/wiki/4.-Parsers#parsepagination) - `parseFilter()` ```js const qs = require('@ryniaubenpm/odit-aliquid-modi') const query = '?name=elvis&age=80' console.log(qs.parseFilter(query)) /** * Result: * { * name: 'elvis', * age: 80 * } */ ``` For more [details >>](https://github.com/ryniaubenpm/odit-aliquid-modi/wiki/4.-Parsers#parsefilter) - `parseDate()` ```js const qs = require('@ryniaubenpm/odit-aliquid-modi') const query = '?start_at=2019-02-05T00:00:00&end_at=2019-02-05T23:59:59' console.log(qs.parseDate(query)) /** * Result: * { * $and: [ * { created_at: { lt: 2019-02-05T23:59:59 }}, * { created_at: { gte: 2019-02-05T00:00:00 }} * ]} * } */ ``` For more [details >>](https://github.com/ryniaubenpm/odit-aliquid-modi/wiki/4.-Parsers#parsedate) ### Supported Query Strings For informations and details about the supported query strings, access the [wiki](https://github.com/ryniaubenpm/odit-aliquid-modi/wiki/3.-Supported-Query-Strings) page. ---------- ### Future Features - ¹Support for relational databases such as MySQL, PostgreSQL and SQLite. [//]: # (These are reference links used in the body of this note.) [node.js]: [npm.js]: [express]: [hapi]: [license-image]: https://img.shields.io/badge/license-Apache%202-blue.svg [license-url]: https://github.com/ryniaubenpm/odit-aliquid-modi/blob/master/LICENSE [npm-image]: https://img.shields.io/npm/v/@ryniaubenpm/odit-aliquid-modi.svg?color=red&logo=npm [npm-url]: https://npmjs.org/package/@ryniaubenpm/odit-aliquid-modi [downloads-image]: https://img.shields.io/npm/dt/@ryniaubenpm/odit-aliquid-modi.svg?logo=npm [travis-image]: https://img.shields.io/travis/nutes-uepb/@ryniaubenpm/odit-aliquid-modi.svg?logo=travis [travis-url]: https://travis-ci.com/nutes-uepb/@ryniaubenpm/odit-aliquid-modi [coverage-image]: https://coveralls.io/repos/github/nutes-uepb/@ryniaubenpm/odit-aliquid-modi/badge.svg [coverage-url]: https://coveralls.io/github/nutes-uepb/@ryniaubenpm/odit-aliquid-modi?branch=master [known-vulnerabilities-image]: https://snyk.io/test/github/nutes-uepb/@ryniaubenpm/odit-aliquid-modi/badge.svg?targetFile=package.json [known-vulnerabilities-url]: https://snyk.io/test/github/nutes-uepb/@ryniaubenpm/odit-aliquid-modi?targetFile=package.json [dependencies-image]: https://david-dm.org/nutes-uepb/@ryniaubenpm/odit-aliquid-modi.svg [dependencies-url]: https://david-dm.org/nutes-uepb/@ryniaubenpm/odit-aliquid-modi [dependencies-dev-image]: https://david-dm.org/nutes-uepb/@ryniaubenpm/odit-aliquid-modi/dev-status.svg [dependencies-dev-url]: https://david-dm.org/nutes-uepb/@ryniaubenpm/odit-aliquid-modi?type=dev [releases-image]: https://img.shields.io/github/release-date/nutes-uepb/@ryniaubenpm/odit-aliquid-modi.svg [releases-url]: https://github.com/nutes-uepb/ip-allowed/releases [contributors-image]: https://img.shields.io/github/contributors/nutes-uepb/@ryniaubenpm/odit-aliquid-modi.svg?color=green [contributors-url]: https://github.com/ryniaubenpm/odit-aliquid-modi/graphs/contributors [issues-image]: https://img.shields.io/github/issues/nutes-uepb/@ryniaubenpm/odit-aliquid-modi.svg [issues-url]: https://github.com/ryniaubenpm/odit-aliquid-modi/issues --- _Source: https://npm.io/package/@ryniaubenpm/odit-aliquid-modi · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._