# @doomcommerce/shopify-search

> Shopify search query builder

Latest version **1.3.1** (published 2023-09-03) · AGPLv3 license · 0 weekly downloads

## Install

```sh
npm install @doomcommerce/shopify-search
pnpm add @doomcommerce/shopify-search
yarn add @doomcommerce/shopify-search
bun add @doomcommerce/shopify-search
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.1 |
| Published | 2023-09-03 |
| First published | 2023-08-31 |
| Weekly downloads | 0 |
| License | AGPLv3 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 60.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | DoomCommerce |
| Maintainers | lowerdimensions |
| Keywords | shopify, node, graphql, search, query, builder |

## Links

- npm: https://www.npmjs.com/package/@doomcommerce/shopify-search
- Repository: https://github.com/DoomCommerce/Shopify-Search
- Issues: https://github.com/DoomCommerce/Shopify-Search/issues
- npm.io page: https://npm.io/package/@doomcommerce/shopify-search

## Dependencies (1)

- [tslib](https://npm.io/package/tslib.md) ^2.6.2

## Alternatives

- [gamedig](https://npm.io/package/gamedig.md) — 29.3K weekly downloads
- [join-monster](https://npm.io/package/join-monster.md) — 12.8K weekly downloads
- [masked](https://npm.io/package/masked.md) — 5.5K weekly downloads
- [@comunica/actor-query-process-explain-logical](https://npm.io/package/@comunica/actor-query-process-explain-logical.md) — 4.7K weekly downloads
- [@veracity/vui](https://npm.io/package/@veracity/vui.md) — 4.6K weekly downloads

## Recent versions

- 1.3.1 (latest) — 2023-09-03
- 1.3.0 — 2023-09-03
- 1.2.8 — 2023-09-02
- 1.2.7 — 2023-09-02
- 1.2.6 — 2023-09-02
- 1.2.4 — 2023-09-02
- 1.2.3 — 2023-09-01
- 1.2.2 — 2023-09-01
- 1.2.1 — 2023-09-01
- 1.2.0 — 2023-09-01
- 1.1.2 — 2023-08-31
- 1.1.1 — 2023-08-31
- 1.1.0 — 2023-08-31
- 1.0.0 — 2023-08-31

## README

<br>

<div align = center >

# Shopify Search <br> Query Builder

Create search query strings with helper functions.

</div>

<br>

<div align = center >

[![Button Installation]][Installation]  
[![Button Usage]][Usage]  
[![Button Examples]][Examples]


<br>

```sh
npm install @doomcommerce/shopify-search
```

</div>

<br>

## Showcase

```ts
import { searchify , include , exclude , and } from '@doomcommerce/shopify-search'

const inRange = include({
    orders : {
        from : 1005 ,
        to : 1010
    }
})

const filterBy = exclude({
    channels : [ 'gid://shopify/Channel/183109583163' ] ,
    tags : [ 'Custom Shipping Rate' ]
})

const query = searchify(and(inRange,filterBy))

console.log(query)
```

<div align = center >

```txt
( name:>=1005 AND name:<=1010 ) AND ( NOT ( 
sales_channel:'gid://shopify/Channel/183109583163' ) 
AND NOT ( tag:'Custom Shipping Rate' ) )
```

*Resolved search query will be optimized in the future.*

</div>

<br>

<!----------------------------------------------------------------------------->

[Button Installation]: https://img.shields.io/badge/Installation-539c3f?style=for-the-badge&logoColor=white&logo=docusign
[Button Examples]: https://img.shields.io/badge/Examples-14539a?style=for-the-badge&logoColor=white&logo=apacheparquet
[Button Usage]: https://img.shields.io/badge/Usage-b85b4a?style=for-the-badge&logoColor=white&logo=applearcade


[Installation]: https://github.com/DoomCommerce/Shopify-Search/tree/Stable/Documentation/Installation.md
[Examples]: https://github.com/DoomCommerce/Shopify-Search/tree/Stable/Examples
[Usage]: https://github.com/DoomCommerce/Shopify-Search/tree/Stable/Documentation/Usage.md

---
_Source: https://npm.io/package/@doomcommerce/shopify-search · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._