# fixturl

> Pattern based fixture generator for urls

Latest version **0.1.4** (published 2014-07-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install fixturl
pnpm add fixturl
yarn add fixturl
bun add fixturl
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.4 |
| Published | 2014-07-27 |
| First published | 2014-07-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jonathan Barnett |
| Maintainers | indieisaconcept |
| Keywords | fixture, testing, urls, generation |

## Links

- npm: https://www.npmjs.com/package/fixturl
- Repository: http://github.com/indieisaconcept/fixturl
- Homepage: https://github.com/indieisaconcept/fixturl
- Issues: https://github.com/indieisaconcept/fixturl/issues
- npm.io page: https://npm.io/package/fixturl

## Dependencies (3)

- [URIjs](https://npm.io/package/URIjs.md) ^1.13.2
- [es6-shim](https://npm.io/package/es6-shim.md) ^0.14.0
- [reverend](https://npm.io/package/reverend.md) ^0.3.0

## Alternatives

- [duck](https://npm.io/package/duck.md) — 4.2M weekly downloads
- [ava](https://npm.io/package/ava.md) — 560.2K weekly downloads
- [storybook-addon-module-mock](https://npm.io/package/storybook-addon-module-mock.md) — 71.7K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads
- [aws-elasticsearch-connector](https://npm.io/package/aws-elasticsearch-connector.md) — 37.4K weekly downloads

## Recent versions

- 0.1.4 (latest) — 2014-07-27
- 0.1.3 — 2014-07-26
- 0.1.1 — 2014-07-26
- 0.1.0 — 2014-07-26

## README

# fixturl

[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-url]][daviddm-image] [![Coverage Status][coveralls-image]][coveralls-url]

`fixturl` is a small library for generating url test fixtures.

## Install

```bash
$ npm install --save fixturl
```

## Usage

```javascript
var fixturl  = require('fixturl'),

    // fixturl(String, Object or Array);

    fixtures = fixturl('http://www.domain.com/:path', {
        param: {
            path: 'news'
        },
        query: {
            foo: 'bar'
        }
    });
```
> Example invocation

Behind the scenes `fixturl` uses [reverend](reverend-url) to support express like route parameter subsitution.

### Combinations

Should you wish to generate multiple combinations for a url this is possible by specifying an array for either params for query.

```javascript
fixturl('/some/path/:id', {
    param: [
        { id: '12345' },
        { id: '6789'  }
    ],
    query: [
        { foo: 'bar' },
        { foo: 'bar', buzz: 'fizz' }
    ]
});
```
> Example of url combinations

`fixturl` will return an array containing generated fixtures. For convenience the following additional Array methods are made available.

### first

```javascript
fixtures.first(); // Returns the first item in the array.
```
### last

```javascript
fixtures.last(); // Returns the last item in the array.
```

### random

```javascript
fixtures.random(); // Returns a random item in the array.
```

## Release History

- **0.1.4** Ensure unique values are returned
- **0.1.3** Keyword updates
- **0.1.2** Documentation fixes
- **0.1.1** Support for combined configs
- **0.1.0** Initial release

## License

Copyright (c) 2014 Jonathan Barnett. Licensed under the MIT license.

[reverend-url]: https://github.com/krakenjs/reverend
[querystring-url]: https://npmjs.org/package/fixturl
[npm-url]: https://npmjs.org/package/fixturl
[npm-image]: https://badge.fury.io/js/fixturl.svg
[travis-url]: https://travis-ci.org/indieisaconcept/fixturl
[travis-image]: https://travis-ci.org/indieisaconcept/fixturl.svg?branch=master
[daviddm-url]: https://david-dm.org/indieisaconcept/fixturl.svg?theme=shields.io
[daviddm-image]: https://david-dm.org/indieisaconcept/fixturl
[coveralls-url]: https://coveralls.io/r/indieisaconcept/fixturl
[coveralls-image]: https://coveralls.io/repos/indieisaconcept/fixturl/badge.png

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