Ich erstelle eine TypeScript-Definitionsdatei für eine JS-Bibliothek eines Drittanbieters. Eines des Verfahrens ermöglicht ein Optionen - Objekt und eine der Eigenschaften des Objekts Optionen akzeptiert eine Zeichenfolge aus der Liste: "collapse", "expand", "end-expand", und "none".

Ich habe eine Schnittstelle für das Optionsobjekt:

interface IOptions {
  indent_size?: number;
  indent_char?: string;
  brace_style?: // "collapse" | "expand" | "end-expand" | "none"
}

Kann die Schnittstelle dies erzwingen ? Wenn Sie also ein IOptionsObjekt in die brace_styleEigenschaft aufnehmen, wird nur eine Zeichenfolge zugelassen, die in der zulässigen Liste enthalten ist.

Dies wurde in Version 1.8 als "String-Literal-Typen" veröffentlicht.

Was ist neu in Typescript - String Literal Types

Beispiel von der Seite:

interface AnimationOptions {
  deltaX: number;
  deltaY: number;
  easing: "ease-in" | "ease-out" | "ease-in-out";
}

Versuche dies

export type ReadingTypes = 'some'|'variants'|'of'|'strings';

export interface IReadings {
   param:ReadingTypes
}

Vielleicht nicht genau das, was Sie wollten, aber es Enumscheint eine perfekte Lösung für Sie zu sein.

enum BraceStyle {Collapse, Expand, EndExpand, None}

interface IOptions {
  indent_size?: number;
  indent_char?: string;
  brace_style?: BraceStyle
}

Aufzählungen basieren jedoch auf Zahlen. BraceStyle.CollapseDies bedeutet, dass zur Laufzeit in diesem Fall ein realer Wert für z. B. 0 ist. Sie können sie jedoch auch mit anderen Skripten verwenden, die keine Typoskripte sind, da sie zu Objekten kompiliert werden. So sieht BraceStyledas Kompilieren und Ausführen aus:

{
    0: "Collapse",
    1: "Expand",
    2: "EndExpand",
    3: "None",
    Collapse: 0,
    Expand: 1,
    EndExpand: 2,
    None: 3
}

Wenn Sie stattdessen Zeichenfolgen möchten, können Sie eine Klasse mit statischen Elementen verwenden, wie hier beschrieben

TS bietet eine Typisierung für bestimmte Zeichenfolgenwerte an, die als Zeichenfolgenliteraltypen bezeichnet werden .

Hier ist ein Beispiel für deren Verwendung:

type style =  "collapse" | "expand" | "end-expand" | "none";

interface IOptions {
  indent_size?: number;
  indent_char?: string;
  brace_style1?:  "collapse" | "expand" | "end-expand" | "none";
  brace_style2?:  style;
}

// Ok
let obj1: IOptions = {brace_style1: 'collapse'};

// Compile time error:
// Type '"collapsessss"' is not assignable to type '"collapse" | "expand" | "end-expand" | "none" | undefined'.
let obj2: IOptions = {brace_style1: 'collapsessss'};

function keysOf<T>(obj: T, key: keyof T) { return obj[key]; }
interface SomeInterface {
   a: string;
}
const instance: SomeInterface = { a: 'some value'};
let value = keysOf<SomeInterface>(instance, 'b'); // invalid
value =  keysOf<SomeInterface>(instance, 'a'); // valid

Ab TypeScript 2.4 können Sie String Enums verwenden

Ich bevorzuge diesen Ansatz, weil dadurch vermieden wird, dass dieselbe fest codierte Zeichenfolge an mehr als einer Stelle vorhanden sein muss.

Es ist möglich, eine Aufzählung zu erstellen, bei der die Werte Zeichenfolgen sind

export enum VISIBILITY {
  PUBLISH = "publish",
  DRAFT = "draft"
}

Diese Aufzählung kann dann als Typ für eine Schnittstelle oder Klasse verwendet werden

export interface UserOptions  {
  visibility:  VISIBILITY 
}