# argosy-pattern

> Test messages against Argosy patterns

Latest version **2.1.0** (published 2015-09-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install argosy-pattern
pnpm add argosy-pattern
yarn add argosy-pattern
bun add argosy-pattern
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.0 |
| Published | 2015-09-01 |
| First published | 2015-05-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jason Pincin |
| Maintainers | jasonpincin |
| Keywords | micro-service, microservice, framework, micro, rpc, stream, pipe |

## Links

- npm: https://www.npmjs.com/package/argosy-pattern
- Repository: https://github.com/jasonpincin/argosy-pattern
- Issues: https://github.com/jasonpincin/argosy-pattern/issues
- npm.io page: https://npm.io/package/argosy-pattern

## Dependencies (3)

- [clone](https://npm.io/package/clone.md) ~1.0.2
- [deep-equal](https://npm.io/package/deep-equal.md) ~1.0.0
- [object-path-get](https://npm.io/package/object-path-get.md) 0.0.2

## Alternatives

- [byte-size](https://npm.io/package/byte-size.md) — 2.1M weekly downloads
- [speed-limiter](https://npm.io/package/speed-limiter.md) — 16.0K weekly downloads
- [@powersync/node](https://npm.io/package/@powersync/node.md) — 10.9K weekly downloads
- [@ledgerhq/coin-cardano](https://npm.io/package/@ledgerhq/coin-cardano.md) — 1.0K weekly downloads
- [@jayesol/jayeson.lib.streamfinder](https://npm.io/package/@jayesol/jayeson.lib.streamfinder.md) — 1.0K weekly downloads

## Recent versions

- 2.1.0 (latest) — 2015-09-01
- 2.0.0 — 2015-08-03
- 1.0.2 — 2015-06-05
- 1.0.1 — 2015-06-04
- 1.0.0 — 2015-05-30

## README

# argosy-pattern

[![NPM version](https://badge.fury.io/js/argosy-pattern.png)](http://badge.fury.io/js/argosy-pattern)
[![Build Status](https://travis-ci.org/jasonpincin/argosy-pattern.svg?branch=master)](https://travis-ci.org/jasonpincin/argosy-pattern)
[![Coverage Status](https://coveralls.io/repos/jasonpincin/argosy-pattern/badge.png?branch=master)](https://coveralls.io/r/jasonpincin/argosy-pattern?branch=master)
[![Davis Dependency Status](https://david-dm.org/jasonpincin/argosy-pattern.png)](https://david-dm.org/jasonpincin/argosy-pattern)

Test messages against Argosy patterns.

Part of the [Argosy](https://github.com/jasonpincin/argosy) family. 

## example

```javascript
var assert        = require('assert'),
    argosyPattern = require('argosy-pattern'),
    match         = require('argosy-pattern/match')

var pattern = argosyPattern({ hello: 'world', 'message.count': match.number })

var result = pattern.matches({
    hello: 'world',
    message: {
        count: 42
    }
})

assert(result)
```

## api

```javascript
var argosyPattern = require('argosy-pattern')
```

### pattern = argosyPattern(object)

Create an Argosy pattern, given an object containing rules. Each key in the object represents a key 
that is to be validated in compared message objects. These keys will be tested to have the same literal 
value, matching regular expression, or to be of a given type using the matching system described below. 
Nested keys may be matched using the dot notation. For example, `{'message.count':1}` equates to 
`{message: {count: 1}}`.

### pattern.matches(object)

Returns true of the given object matches the pattern, or false otherwise. 

### pattern.encode()

Returns an object, representing the pattern, suitable for serialization. This is used internally within 
Argosy.

## matching

```javascript
var match = require('argosy-pattern/match')
```

Argosy patterns support more than literal values. The values of the pattern keys may be any of the following in 
addition to literal values:

* A regular expression - values will be tested against the regular expression to determine a match
* `match.number` - matches any number
* `match.string` - matches any string
* `match.bool` - matches `true` or `false`
* `match.array` - matches any array
* `match.object` - matches any truthy object
* `match.defined` - matches anything other than `undefined`
* `match.undefined` - matches `undefined` or missing key

## testing

`npm test [--dot | --spec] [--grep=pattern]`

Specifying `--dot` or `--spec` will change the output from the default TAP style. 
Specifying `--grep` will only run the test files that match the given pattern.

## coverage

`npm run coverage [--html]`

This will output a textual coverage report. Including `--html` will also open 
an HTML coverage report in the default browser.

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