打字稿包可见性（创建库）

Question

我正在创建一个用于不同项目的打字稿库。 我想要的是只为外部发布我的类函数的一个子集，并在我的库中内部使用其他函数。

在示例中：

/* Person.ts */
export class Person{
    getName(){
        .....
        return name;
    } 
    getInfos(){

    }
}

/* People.ts */
export class People{
    ...
    setName(){
       let p = new Person();
       ...
       let n = p.getName();
       ....
    }

}

我希望我的库公开 Person getInfos() 和 People setName() 但我希望 Person getName 只能在内部访问。 也许我必须创建一个仅向外部用户公开一种方法的 Person.d.ts，但我不明白如何。

谢谢

Answer 1

如果您想在没有特定方法的情况下拥有包含 d.ts 文件的库，您可以执行以下操作

parson.ts

export class Person{
  /** @internal */ <== annotate field with internal flag
  private getName(){
    return name;
  }
  /** @internal */ <== annotate field with internal flag
  public getName2(){
    return name;
  }
  getInfos(){

  }
}

然后通过指定stripInternal 编译选项告诉编译器不要为具有/** @internal */ JSDoc 注释的代码发出声明

tsconfig.json

{
  "compilerOptions": {
    ...
    "declaration": true,
    "stripInternal": true, <== this option

输出应该如下

person.d.ts

export declare class Person {
  getInfos(): void;
}

所以打字稿跳过了所有用/** @internal */注释的字段，即使是public修饰符

Angular 在构建项目时使用相同的方法

Answer 2

您必须区分编译时和运行时封装。如果您只需要编译时封装，您可以使用@trichetriche 建议的方法并将getName 声明为私有或使用@yurzui 更高级的方法。

如果您想要运行时封装，您必须使用不同的方法。如果你导出一个类，它会导出它的所有方法，因为在 JavaScript 中一切都是公开的。要隐藏某些功能，您可以在模块中创建一个函数getName，但不要公开它。您将可以使用它，但它在外面不可用：

function getName() {... return name;}

export class Person{
    getInfos(){
        return getName.call(this);
    }
}

Answer 3

如果您想在内部使用 getName 并且不导出它，只需执行

/* Person.ts */
export class Person{
    protected getName(){
        return getName();
    } 
    getInfos(){

    }
}

/* People.ts */
export class People extends Person {
    ...
    setName(){
      let p = new Person();
      ...
      let n = p.getName();
      ....
    }

}