# @pelevesque/is-offset

> Checks if a string is the offset of another.

Latest version **0.0.8** (published 2020-02-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install @pelevesque/is-offset
pnpm add @pelevesque/is-offset
yarn add @pelevesque/is-offset
bun add @pelevesque/is-offset
```

## 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.8 |
| Published | 2020-02-12 |
| First published | 2019-05-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=9.0.0 |
| Dependencies | 1 |
| Unpacked size | 7.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Pierre-Emmanuel Lévesque |
| Maintainers | pelevesque |
| Keywords | string, offset, offsetted |

## Links

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

## Dependencies (1)

- [@pelevesque/supersubstr](https://npm.io/package/@pelevesque/supersubstr.md) ^1.0.3

## 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

- 0.0.8 (latest) — 2020-02-12
- 0.0.7 — 2019-07-22
- 0.0.6 — 2019-07-22
- 0.0.5 — 2019-06-21
- 0.0.4 — 2019-06-18
- 0.0.3 — 2019-06-17
- 0.0.2 — 2019-05-31
- 0.0.1 — 2019-05-25

## README

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

# is-offset

Checks if a string is the offset of another.

## Node Repository

https://www.npmjs.com/package/@pelevesque/is-offset

## Installation

`npm install @pelevesque/is-offset`

## 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
str1 (required)  
str2 (required)   
step (optional) default = 1
```

### Examples

```js
const isOffset = require('@pelevesque/is-offset')
```

```js
const str1 = 'abcd'
const str2 = 'efgh'
const result = isOffset(str1, str2)
// result === false
```

```js
const str1 = 'abcd'
const str2 = 'bcda'
const result = isOffset(str1, str2)
// result === true
```

```js
const str1 = '111222333444'
const str2 = '333444111222'
const step = 3
const result = isOffset(str1, str2, step)
// result === true
```

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