Have ideas to improve npm?Join in the discussion! »

    ts-cat
    TypeScript icon, indicating that this package has built-in type declarations

    6.0.0 • Public • Published

    ts-cat

    Build Status Coverage Status Codacy Badge npm version Commitizen friendly semantic-release

    A static-land and fantasy-land compliant library containing interfaces for common type-classes and common instances of them.

    This library is currently in very active development. Be aware that changes will be frequent, but that breaking changes will always incur a major version change.

    Limitations

    Static Interfaces

    Be aware that Typescript simply does not support some typing behaviors that would make some things work as expected. The most serious of these issues is that static methods cannot be specified in interfaces. This means that a fantasy-land compliant interface for Applicative cannot be properly created because of can't be enforced as a class method. There is currently an open issue for this here.

    Static Types

    static-land implementations are limited in their ability to properly type results. This appears to be an issue with typescript, rather than an issue with the implementation. Considering the following demonstration with Identity<number>:

    import { identity } from './src/instance/Identity'
     
    const sample = identity.of(5)
    const mapped = identity.map(a => a + 5, sample)

    In this case, typescript may think the type of mapped is Identity<any>, even though it's actually Identity<number>. If we move the static functions from the identity object to the Identity class as static functions, the type issues are resolved. Unfortunately, we would have to define those static functions on the class, rather than setting them equal to the functions from the identity object. Due to Typescript's lack of static interface declarations, this causes us to lose the value of having an interface for the static functions.

    Documentation

    fantasy-land

    static-land

    Theory and Usage

    API Docs

    Install

    npm i ts-cat

    DownloadsWeekly Downloads

    2

    Version

    6.0.0

    License

    MIT

    Unpacked Size

    75 kB

    Total Files

    46

    Last publish

    Collaborators

    • avatar