# tel-splitter

> ハイフンなしの電話番号を分割＆フォーマットする

Latest version **1.1.0** (published 2024-05-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install tel-splitter
pnpm add tel-splitter
yarn add tel-splitter
bun add tel-splitter
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2024-05-08 |
| First published | 2017-09-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=10 |
| Dependencies | 0 |
| Unpacked size | 58.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | black-trooper |
| Maintainers | black_trooper |
| Keywords | tel, telephone, split, splitter, format, formatter |

## Links

- npm: https://www.npmjs.com/package/tel-splitter
- Repository: https://black-trooper@github.com/black-trooper/tel-splitter-js
- Homepage: https://github.com/black-trooper/tel-splitter-js#readme
- Issues: https://github.com/black-trooper/tel-splitter-js/issues
- npm.io page: https://npm.io/package/tel-splitter

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2024-05-08
- 1.0.3 — 2021-10-18
- 1.0.2 — 2021-10-17
- 1.0.1 — 2021-10-17
- 0.0.3 — 2017-09-07
- 0.0.2 — 2017-09-07
- 0.0.1 — 2017-09-01

## README

Tel-Splitter
=============

[![Build Status](https://github.com/black-trooper/tel-splitter/actions/workflows/main.yml/badge.svg)](https://github.com/black-trooper/tel-splitter/actions/workflows/main.yml)
[![codecov](https://codecov.io/gh/black-trooper/tel-splitter/branch/master/graph/badge.svg?token=K0ZRNJsITB)](https://codecov.io/gh/black-trooper/tel-splitter)

## Overview
ハイフンで区切られていない電話番号をフォーマットするツールです。

フォーマットした結果を配列で返すこともできます。

総務省の「市外局番の一覧」を元に作成しています。
http://www.soumu.go.jp/main_sosiki/joho_tsusin/top/tel_number/shigai_list.html

## Install

```sh
npm install --save tel-splitter
```
```javascript
// using ES modules
import * as telSplitter from 'tel-splitter'
// or 
import { format, split } from 'tel-splitter'

// using CommonJS modules
const telSplitter = require('tel-splitter')
// or
const {format, split} = require('tel-splitter')
```

```html
<!-- CDN経由でブラウザ上のscriptタグから呼び出す場合 -->
<script type="text/javascript" src="https://unpkg.com/tel-splitter/telsplitter.umd.production.min.js"></script>
<script>
  console.log(TelSplitter.format('09012345678'))
  console.log(TelSplitter.split('09012345678'))
</script>
```

## Usage

```javascript
import * as telSplitter from 'tel-splitter'

// 電話番号を区切って配列に格納
telSplitter.split('03XXXXYYYY')
// -> ["03", "XXXX", "YYYY"]

// 電話番号をハイフン区切りでフォーマット
telSplitter.format('03XXXXYYYY')
// -> 03-XXXX-YYYY

// 変なところにハイフンが入っていても問題なし
telSplitter.format('03X-XXX-YYYY')
// -> 03-XXXX-YYYY

// 第2引数の strict で携帯電話等の番号の区切り方が変わります。
telSplitter.format('090XXXXYYYY')
// -> 090-XXXX-YYYY
telSplitter.format('090XXXXYYYY', true)
// -> 090-XXX-XYYYY
```

## Thanks
[[PHP] ハイフンなしの電話番号からハイフン付き電話番号を復元する](http://qiita.com/mpyw/items/431c0c8cb70084a74be5)

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