@stdlib/types

stdlib TypeScript type declarations.

Usage no npm install needed!

<script type="module">
  import stdlibTypes from 'https://cdn.skypack.dev/@stdlib/types';
</script>

README

Type Declarations

NPM version Build Status Coverage Status dependencies

TypeScript type declarations for stdlib.

Installation

npm install @stdlib/types

Usage

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

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

function sum( x: ArrayLike ): 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,

/// <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 ( typeof v.value === 'number' ) {
            s += v.value;
        }
        if ( v.done ) {
            break;
        }
    }
    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,

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

Notice

This package is part of 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, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2021. The Stdlib Authors.