Skip to content

Commit b1d9add

Browse files
committed
docs(Orbit-Array-Querier): 📝 BADGES ONLY
📑📑📑📑
1 parent a1a20c5 commit b1d9add

File tree

1 file changed

+18
-27
lines changed

1 file changed

+18
-27
lines changed

README.md

Lines changed: 18 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# 🟢 Array Querier 🔎
2-
[![Compatible Status](https://img.shields.io/badge/works%20with-typescript-blue)](https://www.npmjs.com/package/array-querier)
3-
[![Compatible Status](https://img.shields.io/badge/works%20with-javascript-blue)](https://www.npmjs.com/package/array-querier)
2+
[![Compatible Status](https://img.shields.io/badge/works%20with-ts/js-blue)](https://www.npmjs.com/package/array-querier)
3+
[![Code Size Status](https://img.shields.io/github/languages/code-size/orbitturner/array-querier)](https://www.npmjs.com/package/array-querier)
4+
[![Commit Status](https://img.shields.io/github/commit-activity/m/orbitturner/array-querier?color=red)](https://www.npmjs.com/package/array-querier)
45
[![Issues Status](https://img.shields.io/github/issues/orbitturner/array-querier)](https://www.npmjs.com/package/array-querier)
56
[![npm version](https://img.shields.io/npm/v/array-querier.svg)](https://www.npmjs.com/package/array-querier) [![license](https://img.shields.io/npm/l/array-querier.svg)](https://www.npmjs.com/package/array-querier)
67

@@ -19,29 +20,19 @@
1920
<br/>
2021

2122
___
22-
## Contents
23-
- [array-querier](#array-querier)
24-
* [What is this Library for?](#what-is-this-library-for-)
25-
* [Key Features](#key-features)
26-
* [Installation](#installation)
27-
* [Usage: Standalone](#usage--standalone)
28-
* [Usage: Injection](#usage--injection)
23+
## 📚 Table Of Contents 📑
24+
- [🟢 Array Querier 🔎](#---array-querier---)
25+
* [📚 Table Of Contents 📑](#---table-of-contents---)
26+
* [💨 What is this Library for? 🤔](#---what-is-this-library-for----)
27+
* [✨ Key Features 🎯](#--key-features---)
28+
* [📥 Installation 🔰](#---installation---)
29+
* [🤔 One-Level vs Multi-Level Depth JSON ? 🤔](#---one-level-vs-multi-level-depth-json-----)
30+
* [⚙ Usage: One-Level Depth Arrays (Simple Arrays) 🎚](#--usage--one-level-depth-arrays--simple-arrays----)
31+
+ [➤ Querier.filterSimpleArray(yourData, filterObject); 🟢](#--querierfiltersimplearray-yourdata--filterobject-----)
32+
* [⚙ Usage: Multi-Level Depth Arrays (Complex Arrays) 🎛](#--usage--multi-level-depth-arrays--complex-arrays----)
33+
+ [➤ Querier.filterComplexArray(yourData, filterObject); 🟢](#--querierfiltercomplexarray-yourdata--filterobject-----)
2934
* [Configuration Options](#configuration-options)
30-
+ [`tokenGetter: function(HttpRequest): string`](#-tokengetter--function-httprequest---string-)
31-
+ [`allowedDomains: array`](#-alloweddomains--array-)
32-
+ [`disallowedRoutes: array`](#-disallowedroutes--array-)
33-
+ [`headerName: string`](#-headername--string-)
34-
+ [`authScheme: string | function(HttpRequest): string`](#-authscheme--string---function-httprequest---string-)
35-
+ [`throwNoTokenError: boolean`](#-thrownotokenerror--boolean-)
36-
+ [`skipWhenExpired: boolean`](#-skipwhenexpired--boolean-)
37-
* [Using a Custom Options Factory Function](#using-a-custom-options-factory-function)
38-
* [Configuration for Ionic 2+](#configuration-for-ionic-2-)
39-
* [Configuration Options](#configuration-options-1)
40-
+ [`JwtHelperService: service`](#-jwthelperservice--service-)
41-
* [isTokenExpired (old tokenNotExpired function)](#istokenexpired--old-tokennotexpired-function-)
42-
* [getTokenExpirationDate](#gettokenexpirationdate)
43-
* [decodeToken](#decodetoken)
44-
* [Contributing](#contributing)
35+
* [Contributing ❤](#contributing--)
4536
* [Issue Reporting](#issue-reporting)
4637
* [GREETINGS](#greetings)
4738
* [Author](#author)
@@ -58,7 +49,7 @@ ___
5849
5950

6051

61-
## Key Features
52+
## Key Features 🎯
6253

6354
* Use it **without `Instanciation`** because all the methods are `Static`.
6455
* **Multi Level Depth Filtering** with complex filtering condition.
@@ -67,7 +58,7 @@ ___
6758

6859
___
6960

70-
## Installation
61+
## 📥 Installation 🔰
7162

7263
```bash
7364
# installation with npm
@@ -83,7 +74,7 @@ yarn add array-querier
8374
**This HELPER relies on NOTHING SO YOU DON'T NEED ADDITIONNAL PACKAGES.**
8475

8576
___
86-
### One-Level vs Multi-Level Depth JSON ?
77+
## 🤔 One-Level vs Multi-Level Depth JSON ? 🤔
8778

8879
A JSON depth level is just an nesting of another object within a current JSON object.
8980
For example :

0 commit comments

Comments
 (0)