https://github.com/ramtinsoltani/chisel-addon-phone
https://github.com/ramtinsoltani/chisel-addon-phone
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ramtinsoltani/chisel-addon-phone
- Owner: ramtinsoltani
- Created: 2018-08-27T09:35:24.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-08-27T09:42:17.000Z (almost 7 years ago)
- Last Synced: 2025-01-10T03:48:25.032Z (5 months ago)
- Language: JavaScript
- Size: 3.91 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Phone (Chisel Mutator Addon)
Formats a phone number based on the provided country.
# Installation
Use the Chisel RESTful API, Chisel CLI, or Chisel GUI to install this mutator addon.
# Usage
After installation, this addon will be available on `api.mutators.addons.phone` as a function with the following parameters:
- `number`: A valid phone number in any format.
- `country`: A country code in ISO 3166 format.
- `format`: An optional string, either `int` for International, `nat` for National, `e164` for E164, and `rfc3966` for RFC3966 formatting (defaults to `int`).
## Example
```js
api.mutators.addons.phone('1235556789', 'US'); // Returns "+1 123-555-6789"
api.mutators.addons.phone('1235556789', 'US', 'int'); // Returns "+1 123-555-6789"
api.mutators.addons.phone('1235556789', 'US', 'nat'); // Returns "(123) 555-6789"
api.mutators.addons.phone('1235556789', 'US', 'e164'); // Returns "+11235556789"
api.mutators.addons.phone('1235556789', 'US', 'rfc3966'); // Returns "tel:+1-123-555-6789"
```