npmpackage.info

Gathering detailed insights and metrics for @rasgo/pouchdb-collate

@rasgo/pouchdb-collate - 0.9.2 | npmpackage.info

@rasgo/pouchdb-collate

🦘 - PouchDB is a pocket-sized database.

0.9.2

17,332

Apache-2.0

JavaScript

35.38 kB

4.1

Installations

npm install @rasgo/pouchdb-collate

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

16.20.0

NPM Version

8.19.4 Pull Requests

Open

32

Total

4,712

Closed

2,874

Merged

1,806

Issues

Open

144

Total

4,338

Closed

4,194

Releases

9.0.0

Updated on Jun 21, 2024

8.0.1

Updated on Feb 09, 2023

8.0.0

Updated on Dec 15, 2022

7.3.1

Updated on Nov 11, 2022

7.3.0

Updated on Apr 14, 2022

7.2.2

Updated on Jul 27, 2020

View All 69 releases

Languages

JavaScript

Shell

HTML

Dockerfile

JavaScript (98.77%)

Shell (0.69%)

HTML (0.51%)

Dockerfile (0.03%)

Developer

pouchdb

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

Apache-2.0 License

17,332 Stars

5,251 Commits

1,474 Forks

265 Watchers

1,554 Branches

377 Contributors

Updated on Jul 17, 2025

Maintainers

View All 377 Contributors

Package Meta Information

Latest Version

0.9.2

Package Id

@rasgo/pouchdb-collate@0.9.2

Unpacked Size

35.38 kB

Size

9.05 kB

File Count

NPM Version

8.19.4

Node Version

16.20.0

Published on

Apr 04, 2023

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

PouchDB Collate

Collation functions for PouchDB map/reduce. Used by PouchDB map/reduce to maintain consistent CouchDB collation ordering.

The PouchDB Collate API is not exposed by PouchDB itself, but if you'd like to use it in your own projects, it's pretty small, and it has a few functions you may find useful.

Usage

1npm install pouchdb-collate

1var pouchCollate = require('@rasgo/pouchdb-collate');

Warning: semver-free zone!

This package is conceptually an internal API used by PouchDB or its plugins. It does not follow semantic versioning (semver), and rather its version is pegged to PouchDB's. Use exact versions when installing, e.g. with --save-exact.

Source

PouchDB and its sub-packages are distributed as a monorepo.

For a full list of packages, see the GitHub source.

API

toIndexableString(obj)

This is probably the most useful function in PouchDB Collate. It converts any object to a serialized string that maintains proper CouchDB collation ordering in both PouchDB and CouchDB (ignoring some subtleties with ICU string ordering in CouchDB vs. ASCII string ordering in PouchDB).

So for example, if you want to sort your documents by many properties in an array, you can do e.g.:

1var pouchCollate = require('@rasgo/pouchdb-collate');
2var myDoc = {
3  firstName: 'Scrooge',
4  lastName: 'McDuck',
5  age: 67,
6  male: true
7};
8// sort by age, then gender, then last name, then first name
9myDoc._id = pouchCollate.toIndexableString(
10  [myDoc.age, myDoc.male, mydoc.lastName, mydoc.firstName]);

The doc ID will be:

1'5323256.70000000000000017764\u000021\u00004McDuck\u00004Scrooge\u0000\u0000'

Which is of course totally not human-readable, but it'll sort everything correctly (floats, booleans, ints – you name it). If you need a human-readable doc ID, check out the DocURI project.

Warning! If you are syncing or storing docs in CouchDB, then you will need to modify these doc IDs, due to a bug in how Chrome parses URLs, which causes problems in the replicator when it tries to GET docs at those URLs.

In short, you will need to replace all the \u0000 characters with some other separator. Assuming you're storing text data and not binary data, \u0001 should be fine:

1pouchCollate.toIndexableString([/* ... */])
2    .replace(/\u0000/g, '\u0001');

parseIndexableString(str)

Same as the above, but in reverse. Given an indexable string, it'll give you back a structured object.

For instance:

1var pouchCollate = require('@rasgo/pouchdb-collate');
2
3// [ 67, true, 'McDuck', 'Scrooge' ]
4pouchCollate.parseIndexableString(
5  '5323256.70000000000000017764\u000021\u00004McDuck\u00004Scrooge\u0000\u0000')

collate(obj1, obj2)

Give it two objects, and it'll return a number comparing them. For example:

1pouchCollate.collate('foo', 'bar'); // 1
2pouchCollate.collate('bar', 'foo'); // -1
3pouchCollate.collate('foo', 'foo'); // 0

Of course it sorts more than just strings - any valid JavaScript object is sortable.

normalizeKey(obj)

You shouldn't need to use this, but this function will normalize the object and return what CouchDB would expect - e.g. undefined becomes null, and Dates become date.toJSON(). It's basically what you would get if you called:

1JSON.parse(JSON.stringify(obj));

but a bit faster.

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:172: update your workflow using https://app.stepsecurity.io/secureworkflow/pouchdb/pouchdb/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:212: update your workflow using https://app.stepsecurity.io/secureworkflow/pouchdb/pouchdb/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:251: update your workflow using https://app.stepsecurity.io/secureworkflow/pouchdb/pouchdb/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/pouchdb/pouchdb/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/pouchdb/pouchdb/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:54: update your workflow using https://app.stepsecurity.io/secureworkflow/pouchdb/pouchdb/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:84: update your workflow using https://app.stepsecurity.io/secureworkflow/pouchdb/pouchdb/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:129: update your workflow using https://app.stepsecurity.io/secureworkflow/pouchdb/pouchdb/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/pouchdb/pouchdb/docs.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/docs.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/pouchdb/pouchdb/docs.yml/master?enable=pin
Warn: containerImage not pinned by hash: docs-dev.Dockerfile:2: pin your Docker image by updating ubuntu:20.04 to ubuntu:20.04@sha256:8feb4d8ca5354def3d8fce243717141ce31e2c428701f6682bd2fafe15388214
Warn: downloadThenRun not pinned by hash: docs-dev.Dockerfile:18
Warn: npmCommand not pinned by hash: docs-dev.Dockerfile:28
Info: 0 out of 9 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 1 third-party GitHubAction dependencies pinned
Info: 0 out of 1 containerImage dependencies pinned
Info: 0 out of 1 downloadThenRun dependencies pinned
Info: 0 out of 1 npmCommand dependencies pinned

0

SAST

Determines if the project uses static code analysis.

0

Fuzzing

Determines if the project uses fuzzing.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

4.1

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More