Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stdlib-js/assert-is-alphagram
Test if a value is an alphagram.
https://github.com/stdlib-js/assert-is-alphagram
alphabetical alphagram anagram assert assertion is isalphagram isstring javascript node node-js nodejs order sorted stdlib string util utilities utility utils
Last synced: about 19 hours ago
JSON representation
Test if a value is an alphagram.
- Host: GitHub
- URL: https://github.com/stdlib-js/assert-is-alphagram
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-14T16:54:50.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-01T05:35:41.000Z (about 1 month ago)
- Last Synced: 2024-10-05T20:44:09.029Z (about 1 month ago)
- Topics: alphabetical, alphagram, anagram, assert, assertion, is, isalphagram, isstring, javascript, node, node-js, nodejs, order, sorted, stdlib, string, util, utilities, utility, utils
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 583 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
# isAlphagram
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Test if a value is an [alphagram][alphagram].
## Installation
```bash
npm install @stdlib/assert-is-alphagram
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
- To use as a general utility for the command line, install the corresponding [CLI package][cli-section] globally.
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage
```javascript
var isAlphagram = require( '@stdlib/assert-is-alphagram' );
```
#### isAlphagram( value )
Tests if a `value` is an [alphagram][alphagram] (i.e., a sequence of characters arranged in alphabetical order).
```javascript
var value = 'beep';
var bool = isAlphagram( value );
// returns true
```
## Notes
- The function first checks that an input `value` is a `string` before validating that the `value` is an [alphagram][alphagram]. For non-string values, the function returns `false`.
## Examples
```javascript
var isAlphagram = require( '@stdlib/assert-is-alphagram' );
var out = isAlphagram( 'beep' );
// returns true
out = isAlphagram( new String( 'beep' ) );
// returns true
out = isAlphagram( '' );
// returns false
out = isAlphagram( 'zba' );
// returns false
out = isAlphagram( 123 );
// returns false
```
* * *
## CLI
## Installation
To use as a general utility, install the CLI package globally
```bash
npm install -g @stdlib/assert-is-alphagram-cli
```
### Usage
```text
Usage: is-alphagram [options] []
Options:
-h, --help Print this message.
-V, --version Print the package version.
--split sep Delimiter for stdin data. Default: '/\\r?\\n/'.
```
### Notes
- If the split separator is a [regular expression][mdn-regexp], ensure that the `split` option is either properly escaped or enclosed in quotes.
```bash
# Not escaped...
$ echo -n $'beep\nhello' | is-alphagram --split /\r?\n/
# Escaped...
$ echo -n $'beep\nhello' | is-alphagram --split /\\r?\\n/
```
- The implementation ignores trailing delimiters.
### Examples
```bash
$ is-alphagram beep
true
```
To use as a [standard stream][standard-streams],
```bash
$ echo -n 'hello' | is-alphagram
false
```
By default, when used as a [standard stream][standard-streams], the implementation assumes newline-delimited data. To specify an alternative delimiter, set the `split` option.
```bash
$ echo -n 'beep\thello' | is-alphagram --split '\t'
true
false
```
* * *
## See Also
- [`@stdlib/assert-is-anagram`][@stdlib/assert/is-anagram]: test if a value is an anagram.
* * *
## Notice
This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/assert-is-alphagram.svg
[npm-url]: https://npmjs.org/package/@stdlib/assert-is-alphagram
[test-image]: https://github.com/stdlib-js/assert-is-alphagram/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/assert-is-alphagram/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/assert-is-alphagram/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/assert-is-alphagram?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[cli-section]: https://github.com/stdlib-js/assert-is-alphagram#cli
[cli-url]: https://github.com/stdlib-js/assert-is-alphagram/tree/cli
[@stdlib/assert-is-alphagram]: https://github.com/stdlib-js/assert-is-alphagram/tree/main
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/assert-is-alphagram/tree/deno
[deno-readme]: https://github.com/stdlib-js/assert-is-alphagram/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/assert-is-alphagram/tree/umd
[umd-readme]: https://github.com/stdlib-js/assert-is-alphagram/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/assert-is-alphagram/tree/esm
[esm-readme]: https://github.com/stdlib-js/assert-is-alphagram/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/assert-is-alphagram/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/assert-is-alphagram/main/LICENSE
[alphagram]: https://en.wiktionary.org/wiki/alphagram
[standard-streams]: https://en.wikipedia.org/wiki/Standard_streams
[mdn-regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
[@stdlib/assert/is-anagram]: https://github.com/stdlib-js/assert-is-anagram