在打字稿中的枚举声明中,方括号的含义是什么?

时间:2018-01-03 08:28:09

标签: angular typescript enums ngrx ngrx-store

我正在浏览名为collection.ts的Angular ngrx项目中的一个打字稿文件,在那里,我看到了以下枚举常量被声明。

import { Action } from '@ngrx/store';
import { Book } from '../models/book';

export enum CollectionActionTypes {
  AddBook = '[Collection] Add Book',
  AddBookSuccess = '[Collection] Add Book Success',
  AddBookFail = '[Collection] Add Book Fail',
  RemoveBook = '[Collection] Remove Book',
  RemoveBookSuccess = '[Collection] Remove Book Success',
  RemoveBookFail = '[Collection] Remove Book Fail',
  Load = '[Collection] Load',
  LoadSuccess = '[Collection] Load Success',
  LoadFail = '[Collection] Load Fail',
}

/**
 * Add Book to Collection Actions
 */
export class AddBook implements Action {
  readonly type = CollectionActionTypes.AddBook;

  constructor(public payload: Book) {}
}

export class AddBookSuccess implements Action {
  readonly type = CollectionActionTypes.AddBookSuccess;

  constructor(public payload: Book) {}
}

export class AddBookFail implements Action {
  readonly type = CollectionActionTypes.AddBookFail;

  constructor(public payload: Book) {}
}

/**
 * Remove Book from Collection Actions
 */
export class RemoveBook implements Action {
  readonly type = CollectionActionTypes.RemoveBook;

  constructor(public payload: Book) {}
}

export class RemoveBookSuccess implements Action {
  readonly type = CollectionActionTypes.RemoveBookSuccess;

  constructor(public payload: Book) {}
}

export class RemoveBookFail implements Action {
  readonly type = CollectionActionTypes.RemoveBookFail;

  constructor(public payload: Book) {}
}

/**
 * Load Collection Actions
 */
export class Load implements Action {
  readonly type = CollectionActionTypes.Load;
}

export class LoadSuccess implements Action {
  readonly type = CollectionActionTypes.LoadSuccess;

  constructor(public payload: Book[]) {}
}

export class LoadFail implements Action {
  readonly type = CollectionActionTypes.LoadFail;

  constructor(public payload: any) {}
}

export type CollectionActions =
  | AddBook
  | AddBookSuccess
  | AddBookFail
  | RemoveBook
  | RemoveBookSuccess
  | RemoveBookFail
  | Load
  | LoadSuccess
  | LoadFail;

为枚举常量提供一个值很好,但我很困惑这个[Collection]在这里表示的是每个常量的一部分。像这样的写作对枚举常量的值没有影响还是显示其他东西?有人可以解释一下吗?

2 个答案:

答案 0 :(得分:2)

你可能正在使用像ngrx store或类似的一些flux / redux框架。此枚举定义了操作并确保您的操作键(字符串)在全局级别上是唯一的,因为最后,它们都会合并为一组减少响应的操作。 为了帮助满足这个条件,您通常会将操作所用的类型放在方括号中的键的开头。它只是一个与打字稿无关的命名约定。

例如,

您可以拥有实体BookCategory。对于他们两个,您可以使用键Load Entity进行操作。要区分这两个操作键,一个约定是放置[Book] Load Entity[Category] Load Entity等名称。

答案 1 :(得分:0)

由于括号在值字符串中,因此就enum或TypeScript而言,它们没有内在含义。括号内的值只是该特定项目的惯例 - 它们可以是括号或括号,无关紧要 - 它们可能会或可能不会以其他方式使用。

您可能正在考虑或已经看到的类似语法将是计算密钥,例如:

const propNam = 'test';
const obj = {[propName]: 2};
console.log(obj.test); // 2

但是,enum声明中不允许这些内容。如果从enum声明中查看已编译的JavaScript,它确实使用计算键来实现反向映射(如this page所述):

打字稿:

enum Enum {
    A
}
let a = Enum.A;
let nameOfA = Enum[a]; // "A"

JavaScript的:

var Enum;
(function (Enum) {
    Enum[Enum["A"] = 0] = "A";
})(Enum || (Enum = {}));
var a = Enum.A;
var nameOfA = Enum[a]; // "A"

但这与您案例中括号的使用有很大不同。