dots.typescript.source-file

Liking cljdoc? Tell your friends :D

ClojureScript only.

amd-dependencies^cljs

(amd-dependencies source-file)

Returns: readonly AmdDependency[]

**Returns:** `readonly AmdDependency[]`

source raw docstring

child-at^cljs

(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`

source raw docstring

child-count^cljs

(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`

source raw docstring

children^cljs

(children source-file)

(children this-source-file source-file)

Parameters:

source-file: SourceFile | undefined

Returns: Node[]

**Parameters:**
- `source-file`: `SourceFile | undefined`

**Returns:** `Node[]`

source raw docstring

declaration-file?^cljs

(declaration-file? source-file)

Returns: boolean

**Returns:** `boolean`

source raw docstring

end^cljs

(end source-file)

Returns: number

**Returns:** `number`

source raw docstring

end-of-file-token^cljs

(end-of-file-token source-file)

Returns: Token<SyntaxKind.EndOfFileToken>

**Returns:** `Token<SyntaxKind.EndOfFileToken>`

source raw docstring

file-name^cljs

(file-name source-file)

Returns: string

**Returns:** `string`

source raw docstring

first-token^cljs

(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`

source raw docstring

flags^cljs

(flags source-file)

Returns: NodeFlags

**Returns:** `NodeFlags`

source raw docstring

for-each-child^cljs

(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`

source raw docstring

full-start^cljs

(full-start source-file)

Returns: number

**Returns:** `number`

source raw docstring

full-text^cljs

(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`

source raw docstring

full-width^cljs

(full-width source-file)

Returns: number

**Returns:** `number`

source raw docstring

get-end^cljs

(get-end source-file)

Returns: number

**Returns:** `number`

source raw docstring

get-text^cljs

(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`

source raw docstring

has-no-default-lib?^cljs

(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`

source raw docstring

implied-node-format^cljs

(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`

source raw docstring

kind^cljs

(kind source-file)

Returns: SyntaxKind.SourceFile

**Returns:** `SyntaxKind.SourceFile`

source raw docstring

language-variant^cljs

(language-variant source-file)

Returns: LanguageVariant

**Returns:** `LanguageVariant`

source raw docstring

language-version^cljs

(language-version source-file)

Returns: ScriptTarget

**Returns:** `ScriptTarget`

source raw docstring

last-token^cljs

(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`

source raw docstring

leading-trivia-width^cljs

(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`

source raw docstring

lib-reference-directives^cljs

(lib-reference-directives source-file)

Returns: readonly FileReference[]

**Returns:** `readonly FileReference[]`

source raw docstring

line-and-character-of-position^cljs

(line-and-character-of-position source-file pos)

Parameters:

pos: number

Returns: LineAndCharacter

**Parameters:**
- `pos`: `number`

**Returns:** `LineAndCharacter`

source raw docstring

line-end-of-position^cljs

(line-end-of-position source-file pos)

Parameters:

pos: number

Returns: number

**Parameters:**
- `pos`: `number`

**Returns:** `number`

source raw docstring

line-starts^cljs

(line-starts source-file)

Returns: readonly number[]

**Returns:** `readonly number[]`

source raw docstring

module-name^cljs

(module-name source-file)

Returns: string | undefined

**Returns:** `string | undefined`

source raw docstring

parent^cljs

(parent source-file)

Returns: Node

**Returns:** `Node`

source raw docstring

pos^cljs

(pos source-file)

Returns: number

**Returns:** `number`

source raw docstring

position-of-line-and-character^cljs

(position-of-line-and-character source-file line character)

Parameters:

line: number
character: number

Returns: number

**Parameters:**
- `line`: `number`
- `character`: `number`

**Returns:** `number`

source raw docstring

referenced-files^cljs

(referenced-files source-file)

Returns: readonly FileReference[]

**Returns:** `readonly FileReference[]`

source raw docstring

set-amd-dependencies!^cljs

(set-amd-dependencies! source-file value)

source

set-file-name!^cljs

(set-file-name! source-file value)

source

set-has-no-default-lib!^cljs

(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.

source raw docstring

set-implied-node-format!^cljs

(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.

source raw docstring

set-is-declaration-file!^cljs

(set-is-declaration-file! source-file value)

source

set-language-variant!^cljs

(set-language-variant! source-file value)

source

set-language-version!^cljs

(set-language-version! source-file value)

source

set-lib-reference-directives!^cljs

(set-lib-reference-directives! source-file value)

source

set-module-name!^cljs

(set-module-name! source-file value)

source

set-referenced-files!^cljs

(set-referenced-files! source-file value)

source

set-text!^cljs

(set-text! source-file value)

source

set-type-reference-directives!^cljs

(set-type-reference-directives! source-file value)

source

source-file^cljs

(source-file source-file)

Returns: SourceFile

**Returns:** `SourceFile`

source raw docstring

start^cljs

(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`

source raw docstring

statements^cljs

(statements source-file)

Returns: NodeArray<Statement>

**Returns:** `NodeArray<Statement>`

source raw docstring

text^cljs

(text source-file)

Returns: string

**Returns:** `string`

source raw docstring

type-reference-directives^cljs

(type-reference-directives source-file)

Returns: readonly FileReference[]

**Returns:** `readonly FileReference[]`

source raw docstring

update^cljs

(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`

source raw docstring

width^cljs

(width source-file)

(width this-source-file source-file)

Parameters:

source-file: SourceFileLike | undefined

Returns: number

**Parameters:**
- `source-file`: `SourceFileLike | undefined`

**Returns:** `number`

source raw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts

`Ctrl`+`k`	Jump to recent docs
`←`	Move to previous article
`→`	Move to next article
`Ctrl`+`/`	Jump to the search field

Raise an issue Browse cljdoc source Chat on Slack

× close