Skip to content

Commit

Permalink
chore: prep for deploy
Browse files Browse the repository at this point in the history
  • Loading branch information
crookse committed Sep 14, 2021
1 parent ae20d0a commit d5d127a
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 9 deletions.
4 changes: 4 additions & 0 deletions docs/api_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,10 @@ A collection is a class that wraps itself around an array or object. When constr
console.log(result.get()); // Outputs { field_1_1_1: [ "hello from field_1_1_1" ] }
```

#### `.search()`

See the [Searching](./tutorials/searching.md) tutorial for more information on this API.

##### `.stringify()`

* Description
Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart/browser_javascript.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<body>
<p>Open up your console to see Accio working.</p>
<script type="module">
import { accio } from "https://unpkg.com/@drashland/accio@1.1.2/lib/esm/accio.js";
import { accio } from "https://unpkg.com/@drashland/accio@1.2.0/lib/esm/accio.js";
(async() => {
const response = await fetch("https://raw.githubusercontent.com/drashland/accio/main/example_data.json");
const data = await response.text();
Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart/deno_javascript.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
2. Create your `app.js` file.

```javascript
import { accio } from "https://unpkg.com/@drashland/accio@1.1.2/lib/esm/accio.js";
import { accio } from "https://unpkg.com/@drashland/accio@1.2.0/lib/esm/accio.js";
const decoder = new TextDecoder();

const data = decoder.decode(Deno.readFileSync("./data.json"));
Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart/deno_typescript.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
2. Create your `app.ts` file.

```typescript
import { accio } from "https://unpkg.com/@drashland/accio@1.1.2/lib/deno/accio.ts";
import { accio } from "https://unpkg.com/@drashland/accio@1.2.0/lib/deno/accio.ts";
const decoder = new TextDecoder();

const data = decoder.decode(Deno.readFileSync("./data.json"));
Expand Down
10 changes: 5 additions & 5 deletions docs/tutorials/searching.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ For simplicity, this tutorial will use Node and JavaScript.
4. Create your `app.js` file.
```javascript
const { accio } = require("../../lib/cjs/accio");
const { accio } = require("@drashland/accio");
const { readFileSync } = require("fs");
const data = readFileSync("./data.json", "utf-8");
Expand Down Expand Up @@ -94,7 +94,7 @@ You can use one or all options with the `.search()` method. If you use all optio
You can flatten your search results to only return the `value` field in your search results set. For example ...

```javascript
const { accio } = require("../../lib/cjs/accio");
const { accio } = require("@drashland/accio");
const { readFileSync } = require("fs");

const data = readFileSync("./data.json", "utf-8");
Expand Down Expand Up @@ -125,7 +125,7 @@ console.log(results);
Just like MongoDB's `projection` option, you can tell the `.search()` method to only return the fields that you are interested in. For example ...

```javascript
const { accio } = require("../../lib/cjs/accio");
const { accio } = require("@drashland/accio");
const { readFileSync } = require("fs");

const data = readFileSync("./data.json", "utf-8");
Expand Down Expand Up @@ -164,7 +164,7 @@ console.log(results);
If you want to transform your data further, you can use this option to transform your data to your liking.

```javascript
const { accio } = require("../../lib/cjs/accio");
const { accio } = require("@drashland/accio");
const { readFileSync } = require("fs");

const data = readFileSync("./data.json", "utf-8");
Expand Down Expand Up @@ -198,4 +198,4 @@ console.log(results);
// value: { title: 'Bug Fixes', body: [Array], has_body: true }
// }
// ]
```
```
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@drashland/accio",
"version": "1.1.2",
"version": "1.2.0-alpha-1",
"description": "An easy way to search for deeply nested data in large datasets",
"main": "./lib/cjs/accio.js",
"types": "./lib/cjs/accio.d.ts",
Expand Down

0 comments on commit d5d127a

Please sign in to comment.