@stdlib/assert/is-startcase/README.md

Standard assertion utilities.

<!--

@license Apache-2.0

Copyright (c) 2022 The Stdlib Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->

# isStartcase

> Test if a value is a startcase string.

<section class="usage">

## Usage

```javascript
var isStartcase = require( '@stdlib/assert/is-startcase' );
```

#### isStartcase( value )

Tests if a `value` is a startcase `string` (i.e., the first character of each word is uppercase).

```javascript
var bool = isStartcase( 'Beep Boop' );
// returns true

bool = isStartcase( 'Beep and Boop' );
// returns false
```

</section>

<!-- /.usage -->

<section class="notes">

## Notes

-   The function validates that a `value` is a `string`. For all other types, the function returns `false`.

</section>

<!-- /.notes -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var isStartcase = require( '@stdlib/assert/is-startcase' );

var bool = isStartcase( 'Beep Boop' );
// returns true

bool = isStartcase( 'BeepBoop123' );
// returns true

bool = isStartcase( 'beep Boop' );
// returns false

bool = isStartcase( 'beep' );
// returns false

bool = isStartcase( 'beepBoop' );
// returns false

bool = isStartcase( null );
// returns false
```

</section>

<!-- /.examples -->

* * *

<section class="cli">

## CLI

<section class="usage">

### Usage

```text
Usage: is-startcase [options] [<string>]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.
         --split sep           Delimiter for stdin data. Default: '/\\r?\\n/'.
```

</section>

<!-- /.usage -->

<!-- CLI usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="notes">

### 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 BooP\nFOO' | is-startcase --split /\r?\n/
    # Escaped...
    $ echo -n $'BeEp BooP\nFOO' | is-startcase --split /\\r?\\n/
    ```

-   The implementation ignores trailing delimiters.

</section>

<!-- /.notes -->

<section class="examples">

### Examples

```bash
$ is-startcase BeepBoop
true
```

To use as a [standard stream][standard-streams],

```bash
$ echo -n 'Beep Boop' | is-startcase
true
```

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 'beepBoop\tBEEP_BOOP' | is-startcase --split '\t'
false
true
```

</section>

<!-- /.examples -->

</section>

<!-- /.cli -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">

<!-- /.related -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="links">

[standard-streams]: https://en.wikipedia.org/wiki/Standard_streams

[mdn-regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions

<!-- <related-links> -->

<!-- </related-links> -->

</section>

<!-- /.links -->