如何用打字稿描述简单的Just函子的接口?

时间:2018-08-29 17:08:01

标签: javascript typescript visual-studio-code jestjs typescript-typings

我试图第一次用打字稿编写一个简单的界面,并对几乎所有内容都有疑问。

问题很简单。如何描述这个简单的玩笑匹配器扩展?

/**
 * @param {*} v Any value
 */
function just (v) {
  return {
    fmap: f => just(f(v))
  }
}

expect.extend({
  /** Compare the two values inside two functors with Object.is
   * @method
   * @augments jest.Matchers
   * @param {*} actual The functor you want to test.
   * @param {*} expected The functor you expect.
   */
  functorToBe(actual, expected) {
    const actualValue = getFunctorValue(actual)
    const expectedValue = getFunctorValue(expected)
    const pass = Object.is(actualValue, expectedValue)
    return {
      pass,
      message () {
        return `expected ${actualValue} of ${actual} to ${pass ? '' : 'not'} be ${expectedValue} of ${expected}`
      }
    }
  }
})

test('equational reasoning (identity)', () => {
  expect(just(1)).functorToBe(just(1))
})

我已经尝试过了,但是完全不确定泛型:

import { Matchers } from 'jest'

interface Functor<T> {
  (value?: any): {
    fmap: (f: value) => Functor<T>
  }
}

interface Matchers<R> {
  functorToBe(actual: Functor<T>, expected:  Functor<T>): R
}

参考:JSDoc document object method extending other class

Matchers<R>的笑话类型定义要点:

/**
 * The `expect` function is used every time you want to test a value.
 * You will rarely call `expect` by itself.
 */
interface Expect {
    /**
     * The `expect` function is used every time you want to test a value.
     * You will rarely call `expect` by itself.
     *
     * @param actual The value to apply matchers against.
     */
    <T = any>(actual: T): Matchers<T>;
    /**
     * You can use `expect.extend` to add your own matchers to Jest.
     */
    extend(obj: ExpectExtendMap): void;
    // etc.
}

嗯,这很令人困惑。唯一的回购中唯一的 index.d.ts https://github.com/facebook/jest/blob/master/packages/jest-editor-support/index.d.ts,但这不是我在vscode中获得的https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/jest/index.d.ts#L471

1 个答案:

答案 0 :(得分:2)

扩展名

您对Matchers的合并几乎是正确的,但是从查看肯定类型[1]上的玩笑类型来看,我可以看到Matchers嵌套在jest命名空间中。 《打字稿》手册中涵盖该内容的部分是namespace merging

namespace jest {
    export interface Matchers<R> {
        functorToBe<T>(actual: Functor<T>, expected:  Functor<T>): R;
    }
}

测试时,我需要一个tsconfig.json来获取我的JS文件以查看声明:

{
    "compilerOptions": {
        "allowJs": true,
        "checkJs": true,
    },
    "include": [
        "test.js",
        "extensions.ts",
    ]
}

jsconfig.json几乎是同一件事,但不需要您显式添加"allowJs": true。但是请注意,添加tsconfig或jsconfig会关闭从“确定类型”中自动下载类型,并且您必须手动npm install @types/jest(以及所用库的任何其他类型)。如果您不想添加tsconfig,则可以在JS文件中手动添加引用作为第一行:

/// <reference path="./extensions.ts" />

新方法的类型

应该是这样的:

functorToBe(expected: R): R;

这是让我感到困惑的地方。如果您对问题的这一部分有疑问,请告诉我,我将尽力提供帮助。