(amd-dependencies source-file)
Returns: readonly AmdDependency[]
**Returns:** `readonly AmdDependency[]`
(child-at source-file index)
(child-at this-source-file index source-file)
Parameters:
index
: number
source-file
: SourceFile | undefined
Returns: Node
**Parameters:** - `index`: `number` - `source-file`: `SourceFile | undefined` **Returns:** `Node`
(child-count source-file)
(child-count this-source-file source-file)
Parameters:
source-file
: SourceFile | undefined
Returns: number
**Parameters:** - `source-file`: `SourceFile | undefined` **Returns:** `number`
(children source-file)
(children this-source-file source-file)
Parameters:
source-file
: SourceFile | undefined
Returns: Node[]
**Parameters:** - `source-file`: `SourceFile | undefined` **Returns:** `Node[]`
(declaration-file? source-file)
Returns: boolean
**Returns:** `boolean`
(end-of-file-token source-file)
Returns: Token<SyntaxKind.EndOfFileToken>
**Returns:** `Token<SyntaxKind.EndOfFileToken>`
(first-token source-file)
(first-token this-source-file source-file)
Parameters:
source-file
: SourceFile | undefined
Returns: Node | undefined
**Parameters:** - `source-file`: `SourceFile | undefined` **Returns:** `Node | undefined`
(for-each-child source-file cb-node)
(for-each-child source-file cb-node cb-node-array)
Parameters:
cb-node
: (node: Node) => T | undefined
cb-node-array
: ((nodes: NodeArray<Node>) => T | undefined) | undefined
Returns: T | undefined
**Parameters:** - `cb-node`: `(node: Node) => T | undefined` - `cb-node-array`: `((nodes: NodeArray<Node>) => T | undefined) | undefined` **Returns:** `T | undefined`
(full-text source-file)
(full-text this-source-file source-file)
Parameters:
source-file
: SourceFile | undefined
Returns: string
**Parameters:** - `source-file`: `SourceFile | undefined` **Returns:** `string`
(get-text source-file)
(get-text this-source-file source-file)
Parameters:
source-file
: SourceFile | undefined
Returns: string
**Parameters:** - `source-file`: `SourceFile | undefined` **Returns:** `string`
(has-no-default-lib? source-file)
lib.d.ts should have a reference comment like
/// <reference no-default-lib="true"/>
If any other file has this comment, it signals not to include lib.d.ts because this containing file is intended to act as a default library.
Returns: boolean
lib.d.ts should have a reference comment like /// <reference no-default-lib="true"/> If any other file has this comment, it signals not to include lib.d.ts because this containing file is intended to act as a default library. **Returns:** `boolean`
(implied-node-format source-file)
When module
is Node16
or NodeNext
, this field controls whether the
source file in question is an ESNext-output-format file, or a CommonJS-output-format
module. This is derived by the module resolver as it looks up the file, since
it is derived from either the file extension of the module, or the containing
package.json
context, and affects both checking and emit.
It is public so that (pre)transformers can set this field,
since it switches the builtin node
module transform. Generally speaking, if unset,
the field is treated as though it is ModuleKind.CommonJS
.
Note that this field is only set by the module resolution process when
moduleResolution
is Node16
or NodeNext
, which is implied by the module
setting
of Node16
or NodeNext
, respectively, but may be overriden (eg, by a moduleResolution
of node
). If so, this field will be unset and source files will be considered to be
CommonJS-output-format by the node module transformer and type checker, regardless of extension or context.
Returns: ResolutionMode
When `module` is `Node16` or `NodeNext`, this field controls whether the source file in question is an ESNext-output-format file, or a CommonJS-output-format module. This is derived by the module resolver as it looks up the file, since it is derived from either the file extension of the module, or the containing `package.json` context, and affects both checking and emit. It is _public_ so that (pre)transformers can set this field, since it switches the builtin `node` module transform. Generally speaking, if unset, the field is treated as though it is `ModuleKind.CommonJS`. Note that this field is only set by the module resolution process when `moduleResolution` is `Node16` or `NodeNext`, which is implied by the `module` setting of `Node16` or `NodeNext`, respectively, but may be overriden (eg, by a `moduleResolution` of `node`). If so, this field will be unset and source files will be considered to be CommonJS-output-format by the node module transformer and type checker, regardless of extension or context. **Returns:** `ResolutionMode`
(kind source-file)
Returns: SyntaxKind.SourceFile
**Returns:** `SyntaxKind.SourceFile`
(language-variant source-file)
Returns: LanguageVariant
**Returns:** `LanguageVariant`
(language-version source-file)
Returns: ScriptTarget
**Returns:** `ScriptTarget`
(last-token source-file)
(last-token this-source-file source-file)
Parameters:
source-file
: SourceFile | undefined
Returns: Node | undefined
**Parameters:** - `source-file`: `SourceFile | undefined` **Returns:** `Node | undefined`
(leading-trivia-width source-file)
(leading-trivia-width this-source-file source-file)
Parameters:
source-file
: SourceFile | undefined
Returns: number
**Parameters:** - `source-file`: `SourceFile | undefined` **Returns:** `number`
(lib-reference-directives source-file)
Returns: readonly FileReference[]
**Returns:** `readonly FileReference[]`
(line-and-character-of-position source-file pos)
Parameters:
pos
: number
Returns: LineAndCharacter
**Parameters:** - `pos`: `number` **Returns:** `LineAndCharacter`
(line-end-of-position source-file pos)
Parameters:
pos
: number
Returns: number
**Parameters:** - `pos`: `number` **Returns:** `number`
(line-starts source-file)
Returns: readonly number[]
**Returns:** `readonly number[]`
(module-name source-file)
Returns: string | undefined
**Returns:** `string | undefined`
(position-of-line-and-character source-file line character)
Parameters:
line
: number
character
: number
Returns: number
**Parameters:** - `line`: `number` - `character`: `number` **Returns:** `number`
(referenced-files source-file)
Returns: readonly FileReference[]
**Returns:** `readonly FileReference[]`
(set-has-no-default-lib! source-file value)
lib.d.ts should have a reference comment like
/// <reference no-default-lib="true"/>
If any other file has this comment, it signals not to include lib.d.ts because this containing file is intended to act as a default library.
lib.d.ts should have a reference comment like /// <reference no-default-lib="true"/> If any other file has this comment, it signals not to include lib.d.ts because this containing file is intended to act as a default library.
(set-implied-node-format! source-file value)
When module
is Node16
or NodeNext
, this field controls whether the
source file in question is an ESNext-output-format file, or a CommonJS-output-format
module. This is derived by the module resolver as it looks up the file, since
it is derived from either the file extension of the module, or the containing
package.json
context, and affects both checking and emit.
It is public so that (pre)transformers can set this field,
since it switches the builtin node
module transform. Generally speaking, if unset,
the field is treated as though it is ModuleKind.CommonJS
.
Note that this field is only set by the module resolution process when
moduleResolution
is Node16
or NodeNext
, which is implied by the module
setting
of Node16
or NodeNext
, respectively, but may be overriden (eg, by a moduleResolution
of node
). If so, this field will be unset and source files will be considered to be
CommonJS-output-format by the node module transformer and type checker, regardless of extension or context.
When `module` is `Node16` or `NodeNext`, this field controls whether the source file in question is an ESNext-output-format file, or a CommonJS-output-format module. This is derived by the module resolver as it looks up the file, since it is derived from either the file extension of the module, or the containing `package.json` context, and affects both checking and emit. It is _public_ so that (pre)transformers can set this field, since it switches the builtin `node` module transform. Generally speaking, if unset, the field is treated as though it is `ModuleKind.CommonJS`. Note that this field is only set by the module resolution process when `moduleResolution` is `Node16` or `NodeNext`, which is implied by the `module` setting of `Node16` or `NodeNext`, respectively, but may be overriden (eg, by a `moduleResolution` of `node`). If so, this field will be unset and source files will be considered to be CommonJS-output-format by the node module transformer and type checker, regardless of extension or context.
(source-file source-file)
Returns: SourceFile
**Returns:** `SourceFile`
(start source-file)
(start this-source-file source-file)
(start this-source-file source-file include-js-doc-comment?)
Parameters:
source-file
: SourceFile | undefined
include-js-doc-comment?
: boolean | undefined
Returns: number
**Parameters:** - `source-file`: `SourceFile | undefined` - `include-js-doc-comment?`: `boolean | undefined` **Returns:** `number`
(statements source-file)
Returns: NodeArray<Statement>
**Returns:** `NodeArray<Statement>`
(type-reference-directives source-file)
Returns: readonly FileReference[]
**Returns:** `readonly FileReference[]`
(update source-file new-text text-change-range)
Parameters:
new-text
: string
text-change-range
: TextChangeRange
Returns: SourceFile
**Parameters:** - `new-text`: `string` - `text-change-range`: `TextChangeRange` **Returns:** `SourceFile`
(width source-file)
(width this-source-file source-file)
Parameters:
source-file
: SourceFileLike | undefined
Returns: number
**Parameters:** - `source-file`: `SourceFileLike | undefined` **Returns:** `number`
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close