Skip to content

Commit 4fe263f

Browse files
committed
Fix imports and add docblocks
Fixes a problem introduced in y-lohse#1049 where the relative imports changed to suit standalone references to these files on disk—but overlooked that the tsconfig had `src` already mapped.
1 parent c691374 commit 4fe263f

File tree

1 file changed

+30
-6
lines changed

1 file changed

+30
-6
lines changed

ink.d.ts

+30-6
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,41 @@
1-
import { Story, InkList } from './src/engine/Story'
2-
import { Compiler } from './src/compiler/Compiler'
3-
import { CompilerOptions } from './src/compiler/CompilerOptions'
4-
import { PosixFileHandler } from './src/compiler/FileHandler/PosixFileHandler'
5-
import { JsonFileHandler } from './src/compiler/FileHandler/JsonFileHandler'
1+
import { Story, InkList } from './engine/Story'
2+
import { Compiler } from './compiler/Compiler'
3+
import { CompilerOptions } from './compiler/CompilerOptions'
4+
import { PosixFileHandler } from './compiler/FileHandler/PosixFileHandler'
5+
import { JsonFileHandler } from './compiler/FileHandler/JsonFileHandler'
66

77
declare interface Inkjs {
8+
/**
9+
* A Story is the core class that represents a complete Ink narrative, and
10+
* manages runtime evaluation and state.
11+
*/
812
Story: typeof Story
13+
14+
/**
15+
* The underlying type for a list item in Ink.
16+
*/
917
InkList: typeof InkList
18+
19+
/**
20+
* Compiles Ink stories from source.
21+
*/
1022
Compiler: typeof Compiler
23+
24+
/**
25+
* Metadata options for a compiler pass.
26+
*/
1127
CompilerOptions: typeof CompilerOptions
28+
29+
/**
30+
* Resolves and loads Ink sources from a POSIX filesystem.
31+
*/
1232
PosixFileHandler: typeof PosixFileHandler
33+
34+
/**
35+
* Resolves and loads Ink sources from a JSON hierarchy.
36+
*/
1337
JsonFileHandler: typeof JsonFileHandler
1438
}
1539

1640
declare let inkjs: Inkjs
17-
export default inkjs
41+
export default Inkjs

0 commit comments

Comments
 (0)