open-index/open-npm huggingface dataset:
npm package: @financialforcedev/eslint-config
Description: FinancialForce ESLint configuration
Author: financialforce
Latest version: 6.0.0

# Eslint config.

FinancialForce ESLint configuration.

## Install

```
$ npm install @financialforcedev/eslint-config
```

## Usage

	'use strict';

	module.exports = {
		'extends': '@financialforcedev'
	};
npm package: @financialforcedev/orizuru-openapi
Description: OpenAPI generator for Orizuru.
Author: financialforce
Latest version: 2.0.3

# Orizuru OpenAPI schema generator

[![Build Status](https://travis-ci.org/financialforcedev/orizuru-openapi.svg?branch=master)](https://travis-ci.org/financialforcedev/orizuru-openapi)
[![NSP Status](https://nodesecurity.io/orgs/ffres/projects/178e230f-bb6f-4032-8343-fddec5b92397/badge)](https://nodesecurity.io/orgs/ffres/projects/178e230f-bb6f-4032-8343-fddec5b92397)

Orizuru OpenAPI generator is a module that can generate an OpenAPI document from a map of service name to [Avro](https://avro.apache.org/) schemas. Each schema represents an input event that is exposed as a **POST** path, within the OpenAPI definition.

Currently [OpenAPI version 2.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md) documents are generated. 

## Install

```
$ npm install @financialforcedev/orizuru-openapi
```

### Usage

```javascript

const
	openapiGenerator = require('@financialforcedev/orizuru-openapi').generator;

schemaMap = {
  'question': require('./question')
};
 
app.get('/openapi/v2', openapiGenerator.generateV2({
	info: {
		version: '1.0.0',
		title: 'Test',
		description: 'My description'
	}, 
	host: 'localhost:3000', 
	basePath: '/api', 
	schemes: ['http']
}, schemaMap));

```

## Response schema

The Orizuru project is aimed at asynchronous use cases, so the response schema is always a simple id string.

```javascript

schema: {
	type: 'object',
	required: ['id'],
		properties: {
		id: {
			type: 'string'
		}
	}
}

```
## API Docs

Click to view [JSDoc API documentation](http://htmlpreview.github.io/?https://github.com/financialforcedev/orizuru-openapi/blob/master/doc/index.html).
npm package: @financialforcedev/orizuru-transport-kafka
Description: Kafka transport layer for the orizuru package
Author: financialforce
Latest version: 1.0.1

# Orizuru Transport Kafka.

[![Build Status](https://travis-ci.org/financialforcedev/orizuru-transport-redis.svg?branch=master)](https://travis-ci.org/financialforcedev/orizuru-transport-redis)
[![NSP Status](https://nodesecurity.io/orgs/ffres/projects/62120cff-b6b1-4eb6-a608-338d22302f65/badge)](https://nodesecurity.io/orgs/ffres/projects/62120cff-b6b1-4eb6-a608-338d22302f65)

Orizuru Transport Kafka is a transport library for the [Orizuru](https://www.npmjs.com/package/@financialforcedev/orizuru) framework.

## Install

```
$ npm install @financialforcedev/orizuru-transport-kafka
```

## Usage

Use this dependency to specify the transport layer that ```@financialforcedev/orizuru``` uses as Kafka.

	const
		// get classes from orizuru
		{ Server, Handler, Publisher } = require('@financialforcedev/orizuru'),

		// get the transport
		transport = require('@financialforcedev/orizuru-transport-kafka'),

		// configure the transport
		transportConfig = {
		};

	new Server({ transport, transportConfig }))...
	new Handler({ transport, transportConfig })...
	new Publisher({ transport, transportConfig })...


## API Docs

Click to view [JSDoc API documentation](http://htmlpreview.github.io/?https://github.com/financialforcedev/orizuru-transport-kafka/blob/master/doc/index.html).
npm package: @financialforcedev/orizuru-transport-redis
Description: Redis transport layer for the orizuru package
Author: financialforce
Latest version: 3.1.1

# Orizuru Transport Redis.

[![Build Status](https://travis-ci.org/financialforcedev/orizuru-transport-redis.svg?branch=master)](https://travis-ci.org/financialforcedev/orizuru-transport-redis)
[![NSP Status](https://nodesecurity.io/orgs/ffres/projects/a598bbf3-fdde-4ee0-9b4a-17d6e579512a/badge)](https://nodesecurity.io/orgs/ffres/projects/a598bbf3-fdde-4ee0-9b4a-17d6e579512a)

Orizuru Transport Redis is a transport library for the [Orizuru](https://www.npmjs.com/package/@financialforcedev/orizuru) framework.

## Install

```
$ npm install @financialforcedev/orizuru-transport-redis
```

## Usage

Use this dependency to specify the transport layer that ```@financialforcedev/orizuru``` uses as Redis.

	const
		// get classes from orizuru
		{ Server, Handler, Publisher } = require('@financialforcedev/orizuru'),

		// get the transport
		transport = require('@financialforcedev/orizuru-transport-redis'),

		// configure the transport
		transportConfig = {
			url: 'redis://localhost:6379'
		};

	new Server({ transport, transportConfig }))...
	new Handler({ transport, transportConfig })...
	new Publisher({ transport, transportConfig })...


## API Docs

Click to view [JSDoc API documentation](http://htmlpreview.github.io/?https://github.com/financialforcedev/orizuru-transport-redis/blob/master/doc/index.html).