diff --git a/README.md b/README.md index c87e9c7..55243a6 100644 --- a/README.md +++ b/README.md @@ -149,7 +149,7 @@ orderBy( | Type | Value | | :-------------- | :----------------------------------------------------------------------------------- | -| `Identifier` | string | number | (value: T) => unknown | +| `Identifier` | keyof T | number | (value: T) => unknown | | `Order` | 'asc' | 'desc' | (valueA: unknown, valueB: unknown) => number | #### Description diff --git a/docs/README.md b/docs/README.md index 7263996..d081543 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,9 +1,11 @@ -

natural-orderby

+# Welcome to 🌲 natural-orderby -> Lightweight (< 1.6kB gzipped) and performant natural sorting of arrays and collections by differentiating between unicode characters, numbers, dates, etc. +Lightweight (< 1.6kB gzipped) and performant natural sorting of arrays and collections by differentiating between unicode characters, numbers, dates, etc. -[![npm](https://img.shields.io/npm/v/natural-orderby.svg)](https://www.npmjs.com/package/natural-orderby) -[![Build Status](https://travis-ci.org/yobacca/natural-orderby.svg?branch=master)](https://travis-ci.org/yobacca/natural-orderby) [![codecov](https://codecov.io/gh/yobacca/natural-orderby/branch/master/graph/badge.svg)](https://codecov.io/gh/yobacca/natural-orderby) [![dependencies](https://david-dm.org/yobacca/natural-orderby.svg)](https://david-dm.org/yobacca/natural-orderby) +[![npm version](https://img.shields.io/npm/v/natural-orderby.svg)](https://www.npmjs.com/package/natural-orderby) +[![downloads](https://img.shields.io/npm/dm/natural-orderby.svg)](https://www.npmjs.com/package/natural-orderby) +[![CI](https://github.com/yobacca/natural-orderby/workflows/CI/badge.svg)](https://github.com/yobacca/natural-orderby/actions) +[![coverage](https://img.shields.io/codecov/c/github/yobacca/natural-orderby.svg)](https://codecov.io/gh/yobacca/natural-orderby) People sort strings containing numbers differently than most sorting algorithms, which sort values by comparing strings in Unicode code point order. This produces an ordering that is inconsistent with human logic. @@ -147,7 +149,7 @@ orderBy( | Type | Value | | :-------------- | :----------------------------------------------------------------------------------- | -| `Identifier` | string | number | (value: T) => unknown | +| `Identifier` | keyof T | number | (value: T) => unknown | | `Order` | 'asc' | 'desc' | (valueA: unknown, valueB: unknown) => number | #### Description