open-index/open-npm huggingface dataset:
npm package: @richiebono/users-api
Description: Users Libs
Author: richiebono
Latest version: 1.0.6

# NestJSApiUsers

An API to Provide users and authentication:

## Installation

```bash
   $ npm install
```

## Set Enviroment for secret key JWT and other configurations

```bash
   $ cp .env.example .env
```

To set up on multiple environments, such as dev, stage or prod, we do as follows:

```bash
   $ cp .env.example .env.dev # or .env.stage, etc
```

For more info access:
https://docs.docker.com/get-started/

## Install TypeScript Node

```bash
   $ npm install -g ts-node
```

## Running the app

```bash
    # development
    $ npm run start

    # watch mode
    $ npm run start:dev

    # production mode
    $ npm run start:prod
```

## Url Swagger for Api Documentation

```
http://localhost:3000/api/swagger
```

Configure `SWAGGER_USER` and `SWAGGER_PASSWORD` in the .env file and set `NODE_ENV` to `local` or `dev`or `staging` to access the SWAGGER(Open Api) documentation with basic authentication.

```
NODE_ENV=[:enviroments]
SWAGGER_USER=[:user]
SWAGGER_PASSWORD=[:password]
```

If you want to add more environments, include them in the `SWAGGER_ENVS` array in `main.ts`, see the following:

```typescript 
const SWAGGER_ENVS = ['local', 'dev', 'staging'];
```

## Configuring the NODE_API_PORT environment variable as the default port if you don't want to use the default

```
   NODE_API_PORT=3000 
```

## Running tests using jest

`$ npm test`
npm package: @richienb/interweave
Description: Interweave multiple iterables
Author: Richie Bendall
Latest version: 1.0.0

# @richienb/interweave

Interweave multiple iterables

## Install

```sh
npm install @richienb/interweave
```

## Usage

```js
import interweave from '@richienb/interweave';
import arrayDiffer from 'array-differ';

const query = 'unicorn';
const googleResults = await searchGoogle(query);
//=> ['Unicorn - Wikipedia', 'unicorn | Legend, History, & Facts | Britannica']
const duckDuckGoResult = arrayDiffer(await searchDuckDuckGo(query), googleResults);
//=> ['Unicorn | Definition of Unicorn by Merriam-Webster', 'Unicorn - definition of unicorn by The Free Dictionary']

console.log([...interweave(googleResults, duckDuckGoResult)]);
//=> ['Unicorn - Wikipedia', 'Unicorn | Definition of Unicorn by Merriam-Webster', 'unicorn | Legend, History, & Facts | Britannica', 'Unicorn - definition of unicorn by The Free Dictionary']
```

## API

### interweave(...iterables)

#### iterables

Type: `Iterable` (for example, `Array`)

Iterables of values to interweave.
npm package: @richienb/tsconfig
Description: Shared tsconfig for my projects.
Author: Richie Bendall
Latest version: 0.3.0

# TSConfig

Shared tsconfig for my projects.

## Installation

```sh
$ npm install @richienb/tsconfig
```

## Usage

In your `tsconfig.json`:

```json
{
	"extends": "@richienb/tsconfig"
}
```
npm package: @richienb/typedoc
Description: Shared typedoc config for my projects.
Author: Richie Bendall
Latest version: 0.1.1

# Typedoc

Shared typedoc config for my projects.

## Installation

```sh
$ npm install @richienb/typedoc
```

## Usage

In your `typedoc.json`:

```json
{
	"extends": "@richienb/typedoc"
}
```
npm package: @richienb/vlc
Description: An interface to VLC Media Player.
Author: Richie Bendall
Latest version: 3.0.2

# vlc

An interface to VLC Media Player.

## Highlights

- Automatic command encoding and delivery.
- Automatic port acquisition.
- TypeScript support.
- Bundled binaries.
- No native dependencies.
- Actively maintained.

## Install

```sh
npm install @richienb/vlc
```

## Usage

```js
import createVlc from '@richienb/vlc';

const vlc = await createVlc();

// Play audio
await vlc.command('in_play', {
	input: 'audio-file.mp3',
});

// Pause/resume audio
await vlc.command('pl_pause');
```

## API

### createVlc()

Returns a promise which resolves with the vlc instance.

### vlc.info()

Get the current player status. Returns a promise.

### vlc.playlist()

Get the current playlist information. Returns a promise.

### vlc.command(command, options?)

Execute a command on the player. Returns a promise that resolves when the command has been sent.

#### command

Type: `string`

The [command](https://wiki.videolan.org/VLC_HTTP_requests#Full_command_list) to execute.
npm package: @richierich25/shadowizard
Description: Add boxshadow CSS
Author: Richard Abraham
Latest version: 1.1.0

# @richierich25/shadowizard

## What is this

Get perfect shadows every time for the non designer.

## Installation

`npm i @richierich25/shadowizard`

Then..

```javascript
import { shadowizard } from '@richierich/shadowizard';

shadowizard({
  shadow_type: 'soft',
  padding: false
});
```

## Options

Shadowizard supports 2 options, both of which are optional

- *shadow_type* - _hard | soft_ (Defaults to soft)
- *padding* - _boolean_ (Defaults to false)