# @pelevesque/supersubstr

> Like Javascript's substr, but with wrapping and reversed substrings.

Latest version **1.0.3** (published 2020-02-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install @pelevesque/supersubstr
pnpm add @pelevesque/supersubstr
yarn add @pelevesque/supersubstr
bun add @pelevesque/supersubstr
```

## 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 | 1.0.3 |
| Published | 2020-02-11 |
| First published | 2019-05-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=9.0.0 |
| Dependencies | 3 |
| Unpacked size | 7.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Pierre-Emmanuel Lévesque |
| Maintainers | pelevesque |
| Keywords | string, substring, substr |

## Links

- npm: https://www.npmjs.com/package/@pelevesque/supersubstr
- Repository: https://github.com/pelevesque/supersubstr
- Homepage: https://github.com/pelevesque/supersubstr#readme
- Issues: https://github.com/pelevesque/supersubstr/issues
- npm.io page: https://npm.io/package/@pelevesque/supersubstr

## Dependencies (3)

- [string-reverse](https://npm.io/package/string-reverse.md) ^2.0.0
- [@pelevesque/wrap-number](https://npm.io/package/@pelevesque/wrap-number.md) ^0.0.5
- [@pelevesque/scale-number](https://npm.io/package/@pelevesque/scale-number.md) ^0.0.7

## Alternatives

- [@mce/gif](https://npm.io/package/@mce/gif.md) — 2.6K weekly downloads
- [cleanse](https://npm.io/package/cleanse.md) — 173 weekly downloads
- [str](https://npm.io/package/str.md) — 127 weekly downloads
- [naming](https://npm.io/package/naming.md) — 95 weekly downloads
- [tap-telco-api](https://npm.io/package/tap-telco-api.md) — 19 weekly downloads

## Recent versions

- 1.0.3 (latest) — 2020-02-11
- 1.0.2 — 2019-07-22
- 1.0.1 — 2019-06-21
- 1.0.0 — 2019-06-18
- 0.0.4 — 2019-06-18
- 0.0.3 — 2019-06-17
- 0.0.2 — 2019-05-31
- 0.0.1 — 2019-05-24

## README

[![Build Status](https://travis-ci.org/pelevesque/supersubstr.svg?branch=master)](https://travis-ci.org/pelevesque/supersubstr)
[![Coverage Status](https://coveralls.io/repos/github/pelevesque/supersubstr/badge.svg?branch=master)](https://coveralls.io/github/pelevesque/supersubstr?branch=master)
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

# supersubstr

Like Javascript's substr, but with wrapping and reversed substrings.

## Node Repository

https://www.npmjs.com/package/@pelevesque/supersubstr

## Installation

`npm install @pelevesque/supersubstr`

## Tests

Command                      | Description
---------------------------- | ------------
`npm test` or `npm run test` | All Tests Below
`npm run cover`              | Standard Style
`npm run standard`           | Coverage
`npm run unit`               | Unit Tests

## Usage

### Parameters

```js
str     (required)
options (optional) default = { startIndex = 0, length, reverse = false }
```

### Examples

```js
const supersubstr = require('@pelevesque/supersubstr')
```

```js
const str = '12345'
const result = supersubstr(str, { startIndex: 1 })
// result === '2345'
```

```js
const str = '12345'
const result = supersubstr(str, { startIndex: 2, length: 10, reverse: true })
// result === '3215432154'
```

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