Есть ли такая вещь, как публичные статические константы в TypeScript? У меня есть класс, который выглядит так:
export class Library {
public static BOOK_SHELF_NONE: string = "None";
public static BOOK_SHELF_FULL: string = "Full";
}
В этом классе я могу сделать Library.BOOK_SHELF_NONE, и tsc не жалуется. Но если я попытаюсь использовать библиотеку классов в другом месте и попытаюсь сделать то же самое, он не узнает ее.
Здесь этот фрагмент TS скомпилирован (через Игровая площадка TS):
define(["require", "exports"], function(require, exports) {
var Library = (function () {
function Library() {
}
Library.BOOK_SHELF_NONE = "None";
Library.BOOK_SHELF_FULL = "Full";
return Library;
})();
exports.Library = Library;
});
Как вы видите, оба свойства, определенные как public static, просто привязаны к экспортируемой функции (как ее свойства); поэтому они должны быть доступны до тех пор, пока вы должным образом получаете доступ к самой функции.
Если вы хотите, чтобы в современных браузерах что-то большее, чем статическое постоянное значение (в том смысле, что он не может быть изменен другим кодом), вы можете добавить только get -аксесен к классу Library (это будет работать только для браузеров ES5 + и NodeJS):
export class Library {
public static get BOOK_SHELF_NONE():string { return "None"; }
public static get BOOK_SHELF_FULL():string { return "Full"; }
}
var x = Library.BOOK_SHELF_NONE;
console.log(x);
Library.BOOK_SHELF_NONE = "Not Full";
x = Library.BOOK_SHELF_NONE;
console.log(x);
Если вы запустите его, вы увидите, как попытка установить свойство BOOK_SHELF_NONE для нового значения не работает.
В TypeScript 2.0 вы можете использовать readonly для достижения очень похожих результатов:
export class Library {
public static readonly BOOK_SHELF_NONE = "None";
public static readonly BOOK_SHELF_FULL = "Full";
}
Синтаксис немного проще и очевиднее. Однако компилятор предотвращает изменения, а не время выполнения (в отличие от первого примера, когда изменение вообще не будет разрешено, как показано).
Вы можете сделать это, используя namespaces, например:
export namespace Library {
export const BOOK_SHELF_NONE: string = 'NONE';
}
Затем вы можете импортировать его из другого места:
import {Library} from './Library';
console.log(Library.BOOK_SHELF_NONE);
Если вам нужен класс, включите его внутри пространства имен: export class Book {...}
Между тем это можно решить через декоратор в сочетании с Object.freeze или Object.defineProperty, я использую это, это немного красивее, чем использование тонны геттеров. Вы можете скопировать/вставить это прямо TS Playground, чтобы увидеть его в действии. - Есть два варианта
Следующий декоратор преобразует как аннотированные статические, так и нестатические поля в "свойства только для getter".
Примечание. Если переменная экземпляра без начального значения аннотируется @final, то первое присвоенное значение (независимо от того, когда) будет окончательным.
// example
class MyClass {
@final
public finalProp: string = "You shall not change me!";
@final
public static FINAL_FIELD: number = 75;
public static NON_FINAL: string = "I am not final."
}
var myInstance: MyClass = new MyClass();
myInstance.finalProp = "Was I changed?";
MyClass.FINAL_FIELD = 123;
MyClass.NON_FINAL = "I was changed.";
console.log(myInstance.finalProp); // => You shall not change me!
console.log(MyClass.FINAL_FIELD); // => 75
console.log(MyClass.NON_FINAL); // => I was changed.
Декоратор: убедитесь, что вы включили его в свой код!
/**
* Turns static and non-static fields into getter-only, and therefor renders them "final".
* To use simply annotate the static or non-static field with: @final
*/
function final(target: any, propertyKey: string) {
const value: any = target[propertyKey];
// if it currently has no value, then wait for the first setter-call
// usually the case with non-static fields
if (!value) {
Object.defineProperty(target, propertyKey, {
set: function (value: any) {
Object.defineProperty(this, propertyKey, {
get: function () {
return value;
},
enumerable: true,
configurable: false
});
},
enumerable: true,
configurable: true
});
} else { // else, set it immediatly
Object.defineProperty(target, propertyKey, {
get: function () {
return value;
},
enumerable: true
});
}
}
В качестве альтернативы описанному выше декоратору также была бы строгая версия этого, которая даже выдавала бы ошибку, когда кто-то пытался назначить какое-то значение в поле с установленным "use strict";. (Это только статическая часть)
/**
* Turns static fields into getter-only, and therefor renders them "final".
* Also throws an error in strict mode if the value is tried to be touched.
* To use simply annotate the static field with: @strictFinal
*/
function strictFinal(target: any, propertyKey: string) {
Object.defineProperty(target, propertyKey, {
value: target[propertyKey],
writable: false,
enumerable: true
});
}
Возможный недостаток: это будет работать только для ВСЕЙ статики этого класса или для ни одного, но не может применяться к определенной статистике.
/**
* Freezes the annotated class, making every static 'final'.
* Usage:
* @StaticsFinal
* class MyClass {
* public static SOME_STATIC: string = "SOME_STATIC";
* //...
* }
*/
function StaticsFinal(target: any) {
Object.freeze(target);
}
// Usage here
@StaticsFinal
class FreezeMe {
public static FROZEN_STATIC: string = "I am frozen";
}
class EditMyStuff {
public static NON_FROZEN_STATIC: string = "I am frozen";
}
// Test here
FreezeMe.FROZEN_STATIC = "I am not frozen.";
EditMyStuff.NON_FROZEN_STATIC = "I am not frozen.";
console.log(FreezeMe.FROZEN_STATIC); // => "I am frozen."
console.log(EditMyStuff.NON_FROZEN_STATIC); // => "I am not frozen."
Спасибо, WiredPrairie!
Чтобы немного расширить ваш ответ, вот полный пример определения класса констант.
// CYConstants.ts
class CYConstants {
public static get NOT_FOUND(): number { return -1; }
public static get EMPTY_STRING(): string { return ""; }
}
export = CYConstants;
Чтобы использовать
// main.ts
import CYConstants = require("./CYConstants");
console.log(CYConstants.NOT_FOUND); // Prints -1
console.log(CYConstants.EMPTY_STRING); // Prints "" (Nothing!)
Следующее решение также работает с TS 1.7.5.
// Constancts.ts
export const kNotFoundInArray = -1;
export const AppConnectionError = new Error("The application was unable to connect!");
export const ReallySafeExtensions = ["exe", "virus", "1337h4x"];
Для использования:
// Main.ts
import {ReallySafeExtensions, kNotFoundInArray} from "./Constants";
if (ReallySafeExtensions.indexOf("png") === kNotFoundInArray) {
console.log("PNG are really unsafe!!!");
}
Вы можете использовать геттер, чтобы ваша собственность только читала. Пример:
export class MyClass {
private _LEVELS = {
level1: "level1",
level2: "level2",
level2: "level2"
};
public get STATUSES() {
return this._LEVELS;
}
}
Используется в другом классе:
import { MyClass } from "myclasspath";
class AnotherClass {
private myClass = new MyClass();
tryLevel() {
console.log(this.myClass.STATUSES.level1);
}
}
Просто просто "экспортировать" переменную и "импортировать" в свой класс
export var GOOGLE_API_URL = 'https://www.googleapis.com/admin/directory/v1';
// default err string message
export var errStringMsg = 'Something went wrong';
Теперь используйте его как,
import appConstants = require('../core/AppSettings');
console.log(appConstants.errStringMsg);
console.log(appConstants.GOOGLE_API_URL);