SAF Documentation

Appearance

@saflib/imports

Type Alias: FileSpecialty ​

FileSpecialty = { exports: FileExportFact[]; imports: FileImportFact[]; kind: "source"; localExportUsages?: string[]; } | { exports: FileExportFact[]; imports: FileImportFact[]; kind: "test"; localExportUsages?: string[]; testCases: FileTestCaseFact[]; } | { exports: FileExportFact[]; imports: FileImportFact[]; kind: "sql-table"; localExportUsages?: string[]; tables: FileTableFact[]; }

Discriminated specialty for one file. exports and imports are on every kind; kind-only props are testCases (test) and tables (sql-table). localExportUsages is optional for older blob_facts rows (pre analyzer v8).

Type declaration ​

{ exports: FileExportFact[]; imports: FileImportFact[]; kind: "source"; localExportUsages?: string[]; }

exports ​

exports: FileExportFact[]

imports ​

imports: FileImportFact[]

kind ​

kind: "source"

localExportUsages? ​

optional localExportUsages: string[]

Export names referenced as values elsewhere in this file.

{ exports: FileExportFact[]; imports: FileImportFact[]; kind: "test"; localExportUsages?: string[]; testCases: FileTestCaseFact[]; }

exports ​

exports: FileExportFact[]

imports ​

imports: FileImportFact[]

kind ​

kind: "test"

localExportUsages? ​

optional localExportUsages: string[]

testCases ​

testCases: FileTestCaseFact[]

{ exports: FileExportFact[]; imports: FileImportFact[]; kind: "sql-table"; localExportUsages?: string[]; tables: FileTableFact[]; }

exports ​

exports: FileExportFact[]

imports ​

imports: FileImportFact[]

kind ​

kind: "sql-table"

localExportUsages? ​

optional localExportUsages: string[]

tables ​

tables: FileTableFact[]