# moot-interface

> The interface for the moot demo project.

Latest version **0.0.0** (published 2017-10-07) · VOL license · 0 weekly downloads

## Install

```sh
npm install moot-interface
pnpm add moot-interface
yarn add moot-interface
bun add moot-interface
```

## 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.0.0 |
| Published | 2017-10-07 |
| First published | 2017-10-07 |
| Weekly downloads | 0 |
| License | VOL |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | saibotsivad |
| Maintainers | saibotsivad |
| Keywords | cms, moot |

## Links

- npm: https://www.npmjs.com/package/moot-interface
- Repository: https://github.com/saibotsivad/moot-interface
- Homepage: https://github.com/saibotsivad/moot-interface#readme
- Issues: https://github.com/saibotsivad/moot-interface/issues
- npm.io page: https://npm.io/package/moot-interface

## Recent versions

- 0.0.0 (latest) — 2017-10-07

## README

# moot-interface

The browser-based interface for the moot demo.

Uses: rollup, svelte, asr, mannish, etc.

## run scripts

* `build`: runs all build scripts
* `develop`: run watchers to rebuild on changes, run demo server

## required mediator

The moot interface requires a data provider under the mediated name `moot-api`.

This data provider is essentially a [JSON API](http://jsonapi.org/) interface,
but the moot-interface does not keep the HTTP-request opinion: you are free
to create a data provider of any sort, so long as the mediated provider has
a JSON API interface.

You'll need to make a provider named `moot-api`:

```js
mediator.provide('moot-api', request)
```

Where `request` is an object with the following properties:

* `method` *(string, always present)*: Will be a valid, upper-cased HTTP
	request name, e.g. `GET` and `PUT`.
* `url` *(string, always present)*: A valid URL of the form `/${version}/${path}`
	where `version` is the API version number, e.g. `v1`, and `path` is the
	resource indicator path, e.g. `secure/games/abc123`.
* `filter` *(object, optional)*: A key-value object which limits the requested
	resources, e.g. `{ sport: 'football' }`.
* `include` *(object, optional)*: Whether to include related objects, for
	example `{ team: true }` would include a team object in the response, if
	one was defined for the queried resource, while `{ team: false }` would
	explicitly keep it from the returned data.
* `fields` *(object, optional)*: Limit the data in the response. The key is
	the name of the resource to limit, and the value is an array of strings
	which property names, e.g. `{ team: [ 'name' ] }` will only include the
	`name` properties in the `team` object.

The complete list of requests which need to be supported is available
[here](./data-provider.yaml).

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