Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Jan 26, 2024
1 parent c977557 commit 751f783
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 8 deletions.
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,14 @@ npm install @stdlib/array-base-assert

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` branch][esm-url].
- If you are using Deno, visit the [`deno` branch][deno-url].
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd` branch][umd-url].
- 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]).

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.

</section>

<section class="usage">
Expand All @@ -77,7 +79,10 @@ The namespace exports the following:
<div class="namespace-toc">

- <span class="signature">[`contains( x, value )`][@stdlib/array/base/assert/contains]</span><span class="delimiter">: </span><span class="description">test if an array contains a provided search value.</span>
- <span class="signature">[`hasSameValues( x, y )`][@stdlib/array/base/assert/has-same-values]</span><span class="delimiter">: </span><span class="description">test if two arrays have the same values.</span>
- <span class="signature">[`isAccessorArray( value )`][@stdlib/array/base/assert/is-accessor-array]</span><span class="delimiter">: </span><span class="description">test if an array-like object supports the accessor (get/set) protocol.</span>
- <span class="signature">[`isComplex128Array( value )`][@stdlib/array/base/assert/is-complex128array]</span><span class="delimiter">: </span><span class="description">test if a value is a `Complex128Array`.</span>
- <span class="signature">[`isComplex64Array( value )`][@stdlib/array/base/assert/is-complex64array]</span><span class="delimiter">: </span><span class="description">test if a value is a `Complex64Array`.</span>

</div>

Expand Down Expand Up @@ -177,8 +182,11 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules

[deno-url]: https://github.com/stdlib-js/array-base-assert/tree/deno
[deno-readme]: https://github.com/stdlib-js/array-base-assert/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/array-base-assert/tree/umd
[umd-readme]: https://github.com/stdlib-js/array-base-assert/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/array-base-assert/tree/esm
[esm-readme]: https://github.com/stdlib-js/array-base-assert/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/array-base-assert/blob/main/branches.md

[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-assert/main/LICENSE
Expand All @@ -187,8 +195,14 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].

[@stdlib/array/base/assert/contains]: https://github.com/stdlib-js/array-base-assert-contains

[@stdlib/array/base/assert/has-same-values]: https://github.com/stdlib-js/array-base-assert-has-same-values

[@stdlib/array/base/assert/is-accessor-array]: https://github.com/stdlib-js/array-base-assert-is-accessor-array

[@stdlib/array/base/assert/is-complex128array]: https://github.com/stdlib-js/array-base-assert-is-complex128array

[@stdlib/array/base/assert/is-complex64array]: https://github.com/stdlib-js/array-base-assert-is-complex64array

<!-- </toc-links> -->

</section>
Expand Down
11 changes: 7 additions & 4 deletions branches.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ This repository has the following branches:

- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place.
- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network).
- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers.
- **deno**: [Deno][deno-url] branch for use in Deno.
- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments.
- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]).
- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]).
- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]).

The following diagram illustrates the relationships among the above branches:

Expand All @@ -49,5 +49,8 @@ C -->|bundle| F[umd];
[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/assert
[production-url]: https://github.com/stdlib-js/array-base-assert/tree/production
[deno-url]: https://github.com/stdlib-js/array-base-assert/tree/deno
[deno-readme]: https://github.com/stdlib-js/array-base-assert/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/array-base-assert/tree/umd
[esm-url]: https://github.com/stdlib-js/array-base-assert/tree/esm
[umd-readme]: https://github.com/stdlib-js/array-base-assert/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/array-base-assert/tree/esm
[esm-readme]: https://github.com/stdlib-js/array-base-assert/blob/esm/README.md
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
},
"dependencies": {
"@stdlib/array-base-assert-contains": "^0.1.0",
"@stdlib/array-base-assert-has-same-values": "github:stdlib-js/array-base-assert-has-same-values#main",
"@stdlib/array-base-assert-has-same-values": "^0.1.0",
"@stdlib/array-base-assert-is-accessor-array": "^0.1.0",
"@stdlib/array-base-assert-is-complex128array": "^0.1.0",
"@stdlib/array-base-assert-is-complex64array": "^0.1.0",
Expand Down

0 comments on commit 751f783

Please sign in to comment.