A common TypeScript interface for Array and typed arrays
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
examples
.gitignore
.npmignore
.travis.yml
CHANGELOG.md
LICENSE
README.md
index.d.ts
package-lock.json
package.json
tsconfig.json
tslint.json

README.md

Typeable array

travis NPM version

TypeableArray provides a common TypeScript interface for Array and Typed arrays.

ReadonlyTypeableArray provides a readonly interface of TypeableArray.

TypeableArrayConstructor provides a common interface for constructors of Array and Typed arrays.

Why Typeable Arrays?

Typeable Arrays offer an easy way to write codes that handle both arrays and typed arrays. The client can then choose an array or a typed array accoring her needs.

Furthermore, TypeableArrayConstructor is fully generic. This makes TypeableArrayConstructor more type-safe than the provided interfaces in TypeScript library.

How to use

If you use one of the provided types in at least one exported interface, you have to place this package as production dependency:

npm install typeable-array

Otherwise, you can place this package as a dev dependency:

npm install --save-dev typeable-array

Once installed you just need to import it:

import { TypeableArray } from "typeable-array"

Credits

This piece of code was extracted from distile-ts.

License

Licensed under the zlib license.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, shall be licensed as above, without any additional terms or conditions.