Блог

У меня возникли проблемы с получением sinon-stub-promise для работы с typescript. В файле определения @types/sinon-stub-promise отсутствует экспорт по умолчанию. Я внимательно следил за документами по объединению объявлений, но он не компилируется.

Ошибка компиляции:

 index.ts(4,18): error TS2345: Argument of type 'typeof 'sinon'' is not assignable to parameter of type 'SinonSandbox'.                                            
  Property 'clock' is missing in type 'typeof 'sinon''.                                                                                                           
index.ts(6,25): error TS2339: Property 'stub' does not exist on type 'typeof 'sinon''. 
  

Файл определения Sinon:

 declare namespace Sinon {
  // ...

  interface SinonStubStatic {
    (): SinonStub;
    (obj: any): SinonStub;
    (obj: any, method: string): SinonStub;
    (obj: any, method: string, func: any): SinonStub;
  }

  // ...

  interface SinonFakeTimers {
    now: number;
    create(now: number): SinonFakeTimers;
    setTimeout(callback: (...args: any[]) => void, timeout: number, ...args: any[]): number;
    // ...
  }

  interface SinonSandbox {
    clock: SinonFakeTimers;
    // ...
    stub: SinonStubStatic;
    // ...
  }
}
  

Скорректированные типизации sinon-stub-promise:

 // Generated by typings
// Source: https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/7de6c3dd94feaeb21f20054b9f30d5dabc5efabd/sinon-stub-promise/sinon-stub-promise.d.ts
/// <reference path="../../../node_modules/@types/sinon/index.d.ts" />
declare module 'sinon' {
  interface SinonPromise {
    resolves(value?: any): void;
    rejects(value?: any): void;
  }

  interface SinonStub {
    returnsPromise(): SinonPromise;
  }
}

// Added by me, because this is missing in the typings on dt
declare module 'sinon-stub-promise' {
  function setup(sinon: Sinon.SinonSandbox): void;
  export = setup;
}
  

index.ts

 import * as sinon from 'sinon';
import sinonStubPromise = require('sinon-stub-promise');

sinonStubPromise(sinon);
  

Минимальный образец репозитория: https://github.com/marvinhagemeister/typings-bug

Проблема в том, что типизации для sinon have export находятся на верхнем уровне, в самом конце @types/sinon/index.d.ts файла:

 declare var Sinon: Sinon.SinonStatic;

export = Sinon;
  

Что, по-видимому, делает невозможным расширение с использованием окружающих модулей.

Но это выполнимо, если вы также сделаете все модули внешними, однако я понятия не имею, как заставить его работать с типизациями (распространение его, @types с другой стороны, кажется возможным).

Поместите это в sinon.d.ts файл рядом с вашим index.d.ts (так вы объявляете расширение для внешнего sinon модуля — все интерфейсы будут объединены):

 import "sinon";
declare module "sinon" {

    export interface SinonPromise {
        resolves(value?: any): void;
        rejects(value?: any): void;
    }

    export interface SinonStub {
        returnsPromise(): SinonPromise;
    }

    // had to add these from SinonSandbox to SinonStatic
    // 
    // no idea if it's really supposed to have those methods
    export interface SinonStatic {
        requests: SinonFakeXMLHttpRequest;
        server: SinonFakeServer;
        useFakeServer(): SinonFakeServer;
        restore(): void;
    }
}
  

Поместите это в sinon-stub-promise.d.ts файл рядом с вашим index.ts :

 import * as sinon from 'sinon';

declare function setup(sinon: sinon.SinonSandbox): void;

export = setup;
  

Затем в вашем index.ts

 // in order to use your extension you have to import both here
import * as sinon from "sinon";
import "./sinon";


import sinonStubPromise = require("./sinon-stub-promise");

sinonStubPromise(sinon);

const mkdirStub = sinon.stub()
  .returnsPromise().resolves(null);
  

Сгенерированный код javascript выглядит хорошо:

 "use strict";
var sinon = require("sinon");
var sinonStubPromise = require("sinon-stub-promise");
sinonStubPromise(sinon);
var mkdirStub = sinon.stub()
    .returnsPromise().resolves(null);