Introduction

The entries_ordered_by_key package sorts an array of key-value pair objects with string keys, in lexicographical or reverse lexicographical order.

Installation

This package should be installed via npm. You must have npm installed first. The following can be run on the commandline to install the entries_ordered_by_key package with npm:

npm install @nicolawealth/entries_ordered_by_key

Interface

The package exports two functions, entitiesOrderedByKey(entries) and entitiesOrderedByKeyReversed(entries) where entries is of the type [key, value][] i.e. is an array of key-value pair objects. Here key is a string value. entitiesOrderedByKey(entries) will sort entries by lexicographical ordering and entitiesOrderedByKeyReversed(entries) will sort entries by reverse lexicographical ordering.

Testing

Tests can be found in entries_ordered_by_key.test.ts located in entries_ordered_by_key/src and should be run with sinon, mocha and nyc.