# Type Declarations

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] 

> TypeScript type declarations for stdlib.

## Installation

```bash
npm install @stdlib/types
```

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].

## Usage

```typescript
/// <reference types="@stdlib/types"/>

import { ArrayLike } from '@stdlib/types/array';

function sum( x: ArrayLike<number> ): number {
    let s = 0.0;
    for ( let i = 0; i < x.length; i++ ) {
        s += x[ i ];
    }
    return s;
}
```

Type declarations are organized as modules. For example, to use iterator type declarations,

```typescript
/// <reference types="@stdlib/types"/>

import { Iterator } from '@stdlib/types/iter';

function sum( iter: Iterator ): number {
    let s = 0.0;
    while ( true ) {
        let v = iter.next();
        if ( v.done ) {
            break;
        }
        s += v.value;
    }
    return s;
}
```

For the complete list of declared modules, see the `index.d.ts` type declaration file.

## Notes

-   In order to use included TypeScript declarations, configure your `tsconfig.json` file accordingly. For example,

    ```text
    {
      "compilerOptions": {
        ...
        "typeRoots": [ "./path/to/@stdlib/types" ],
        ...
      },
      ...
    }
    ```


* * *

## 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-2022. The Stdlib [Authors][stdlib-authors].

[npm-image]: http://img.shields.io/npm/v/@stdlib/types.svg
[npm-url]: https://npmjs.org/package/@stdlib/types

[test-image]: https://github.com/stdlib-js/types/actions/workflows/test.yml/badge.svg
[test-url]: https://github.com/stdlib-js/types/actions/workflows/test.yml

[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/types/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/types?branch=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/types/tree/deno
[umd-url]: https://github.com/stdlib-js/types/tree/umd
[esm-url]: https://github.com/stdlib-js/types/tree/esm

[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://gitter.im/stdlib-js/stdlib/

[stdlib]: https://github.com/stdlib-js/stdlib

[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors

[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/types/main/LICENSE

