檢查是否一個對象實現在與打字稿運行時

Question

予加載在運行時JSON配置文件，並使用接口來定義它的預期結構的接口：

interface EngineConfig { 
    pathplanner?: PathPlannerConfig; 
    debug?: DebugConfig; 
    ... 
} 

interface PathPlannerConfig { 
    nbMaxIter?: number; 
    nbIterPerChunk?: number; 
    heuristic?: string; 
} 

interface DebugConfig { 
    logLevel?: number; 
} 

... 

這使得方便的，因爲訪問的各種屬性我可以使用自動完成等。

問題：有沒有辦法使用這個聲明來檢查我加載的文件的正確性？即我沒有意想不到的屬性？

Answer 1

號

目前，類型只在開發和編譯時使用。 類型信息沒有以任何方式轉換爲已編譯的 JavaScript代碼。

從https://stackoverflow.com/a/16016688/318557，由@JasonEvans

Answer 2

我不知道你的配置文件是怎麼樣的，但最明顯的是json文件，儘管我會用json模式來驗證文件是否符合模式。

這裏的JSON模式v4的文檔：http://json-schema.org/documentation.html

和例子，你怎麼能測試一個：https://github.com/fge/json-schema-validator

當然，你必須基於接口寫你的架構，但你不能直接使用它們。

Answer 3

是指出。您可以在運行時通過使用前幾次發佈的TypeScript編譯器的增強版進行此檢查。你可以做類似如下：

export interface Person { 
    name: string; 
    surname: string; 
    age: number; 
} 

let personOk = { name: "John", surname: "Doe", age: 36 }; 
let personNotOk = { name: 22, age: "x" }; 

// YES. Now you CAN use an interface as a type reference object. 
console.log("isValid(personOk): " + isValid(personOk, Person) + "\n"); 
console.log("isValid(personNotOk): " + isValid(personNotOk, Person) + "\n"); 

，這是輸出：

isValid(personOk): true 

Field name should be string but it is number 
isValid(personNotOk): false 

請注意：isValid功能工作遞歸，所以你可以用它來驗證嵌套的對象，太。你可以找到完整的工作示例here

Answer 4

我懷疑TypeScript（明智地）遵守Curly定律，而Typescript是一個轉譯器，而不是一個對象驗證器。也就是說，我還認爲打字稿界面會導致糟糕的對象驗證，因爲界面有一個（奇妙）有限的詞彙表，並且無法驗證其他程序員可能用來區分對象的形狀，例如數組長度，屬性數量，圖案特性等

當消耗來自非打字稿代碼對象，我使用了JSONSchema驗證包，如AJV，用於運行時間驗證，和一個.d.ts文件發生器（如DTSgenerator或DTS-generator）從我的JSONshcema中編譯TypeScript類型定義。

主要需要注意的是，由於JSONschemata能夠描述不能被打字稿進行區分的形狀（如patternProperties），它不是從JSON架構.t.ds一個到一個翻譯，你可能有做一些手工編輯生成的.d。ts文件時使用這種JSON模式。這就是說，因爲其他程序員可能會使用像數組長度這樣的屬性來推斷對象類型，所以我習慣區分可能被TypeScript編譯器使用枚舉來混淆的類型，以防止轉譯器接受一種類型的使用在地方，其他像這樣的：

[MyTypes.yaml] 

definitions: 
    type-A: 
     type: object 
     properties: 
      type: 
       enum: 
       - A 
      foo: 
       type: array 
       item: string 
       maxLength: 2 
    type-B: 
     type: object 
     properties: 
      type: 
       enum: 
       - B 
      foo: 
       type: array 
       item: string 
       minLength: 3 
     items: number 

生成一個.d.ts文件像這樣：

[MyTypes.d.ts] 

interface typeA{ 
    type: "A"; 
    foo: string[]; 
} 

interface typeB{ 
    type: "B"; 
    foo: string[]; 
} 

Answer 5

有「是」的方式，但你必須實現它自己。它被稱爲「用戶定義類型衛士」，它看起來像這樣：

interface Test { 
    prop: number; 
} 

function isTest(arg: any): arg is Test { 
    return arg && arg.prop && typeof(arg.prop) == 'number'; 
} 

當然，isTest功能的實際執行是完全取決於你，但好的部分是，它是一個真正的功能，意味着它是可測試的。

現在在運行時，您將使用isTest()來驗證對象是否遵守接口。在編譯時打字稿拿起在保護和對待如預期後續使用，即：

let a:any = { prop: 5 }; 

a.x; //ok because here a is of type any 

if (isTest(a)) { 
    a.x; //error because here a is of type Test 
} 

更深入的解釋在這裏：https://basarat.gitbooks.io/typescript/content/docs/types/typeGuard.html

Answer 6

是的，有一個lib，做它https://github.com/gcanti/io-ts

這個想法很簡單，有簡單的檢查屬性組成更復雜的對象檢查

Answer 7

這是一個好方法。您可以使用typescript-json-schema將TypeScript接口轉換爲JSON模式。

typescript-json-schema --required --noExtraProps \ 
    -o YOUR_SCHEMA.json YOUR_CODE.ts YOUR_INTERFACE_NAME 

然後在運行時使用JSON模式驗證如ajv，例如驗證數據

const fs = require('fs'); 
const Ajv = require('ajv'); 

// Load schema 
const schema = JSON.parse(fs.readFileSync('YOUR_SCHEMA.json', {encoding:"utf8"})); 
const ajv = new Ajv(); 
ajv.addMetaSchema(require('ajv/lib/refs/json-schema-draft-04.json')); 
var validator = ajv.compile(schema); 

if (!validator({"hello": "world"})) { 
    console.log(validator.errors); 
} 

Answer 8

這裏是另一種選擇，專門爲此：

ts-interface-builder是你在編譯的時候你的打字稿文件（例如foo.ts）運行建設運行的描述符（例如foo-ti.ts）的工具。

ts-interface-checker使用這些在運行時驗證對象。例如。

import {createCheckers} from 'ts-interface-checker'; 
import fooDesc from 'foo-ti.ts'; 
const checkers = createCheckers(fooDesc); 

checkers.EngineConfig.check(someObject); // Succeeds or throws an informative error 
checkers.PathPlannerConfig.check(someObject); 

您可以使用strictCheck()方法確保沒有未知屬性。