如何输入自定义桩api?

How to type a custom pilet api?

我们正在使用微前端框架piral。对于我们的 pilets,我们想提供一个自定义 api。按照教程,我们想出了这样的代码

export interface MyApi {
  example(): void;
}

export function createMyApi(): Extend<MyApi> {
  return context => {
    return (api, target) => {
      return {
        example() {
          alert(`Hello from ${target.name}!`);
        }
      };
    };
  };
}

虽然这似乎在功能上有效,但我们无法让它与打字稿一起使用。我们做错了什么?我们怎样才能在 pilets 中也提供打字?

我认为您可能缺少正确的声明合并。

import { PiletApi } 'piral-core';

declare module 'piral-core/lib/types/custom' {
  interface PiletCustomApi extends MyApi {}
}

总而言之:

import { PiletApi } 'piral-core';

export interface MyApi {
  example(): void;
}

declare module 'piral-core/lib/types/custom' {
  interface PiletCustomApi extends MyApi {}
}

export function createMyApi(): Extend<MyApi> {
  return context => {
    return (api, target) => {
      return {
        example() {
          alert(`Hello from ${target.name}!`);
        }
      };
    };
  };
}

希望对您有所帮助!