Liking cljdoc? Tell your friends :D

dots.typescript.json-source-file


amd-dependenciescljs

(amd-dependencies json-source-file)

Returns: readonly AmdDependency[]

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

child-atcljs

(child-at json-source-file index)
(child-at json-source-file index source-file)

Parameters:

  • index: number
  • source-file: SourceFile | undefined

Returns: Node

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

**Returns:** `Node`
sourceraw docstring

child-countcljs

(child-count json-source-file)
(child-count json-source-file source-file)

Parameters:

  • source-file: SourceFile | undefined

Returns: number

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

**Returns:** `number`
sourceraw docstring

childrencljs

(children json-source-file)
(children json-source-file source-file)

Parameters:

  • source-file: SourceFile | undefined

Returns: Node[]

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

**Returns:** `Node[]`
sourceraw docstring

declaration-file?cljs

(declaration-file? json-source-file)

Returns: boolean

**Returns:** `boolean`
sourceraw docstring

endcljs

(end json-source-file)

Returns: number

**Returns:** `number`
sourceraw docstring

end-of-file-tokencljs

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

Returns: Token<SyntaxKind.EndOfFileToken>

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

file-namecljs

(file-name json-source-file)

Returns: string

**Returns:** `string`
sourceraw docstring

first-tokencljs

(first-token json-source-file)
(first-token json-source-file source-file)

Parameters:

  • source-file: SourceFile | undefined

Returns: Node | undefined

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

**Returns:** `Node | undefined`
sourceraw docstring

flagscljs

(flags json-source-file)

Returns: NodeFlags

**Returns:** `NodeFlags`
sourceraw docstring

for-each-childcljs

(for-each-child json-source-file cb-node)
(for-each-child json-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`
sourceraw docstring

full-startcljs

(full-start json-source-file)

Returns: number

**Returns:** `number`
sourceraw docstring

full-textcljs

(full-text json-source-file)
(full-text json-source-file source-file)

Parameters:

  • source-file: SourceFile | undefined

Returns: string

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

**Returns:** `string`
sourceraw docstring

full-widthcljs

(full-width json-source-file)

Returns: number

**Returns:** `number`
sourceraw docstring

get-endcljs

(get-end json-source-file)

Returns: number

**Returns:** `number`
sourceraw docstring

get-textcljs

(get-text json-source-file)
(get-text json-source-file source-file)

Parameters:

  • source-file: SourceFile | undefined

Returns: string

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

**Returns:** `string`
sourceraw docstring

has-no-default-lib?cljs

(has-no-default-lib? json-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`
sourceraw docstring

implied-node-formatcljs

(implied-node-format json-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`
sourceraw docstring

kindcljs

(kind json-source-file)

Returns: SyntaxKind.SourceFile

**Returns:** `SyntaxKind.SourceFile`
sourceraw docstring

language-variantcljs

(language-variant json-source-file)

Returns: LanguageVariant

**Returns:** `LanguageVariant`
sourceraw docstring

language-versioncljs

(language-version json-source-file)

Returns: ScriptTarget

**Returns:** `ScriptTarget`
sourceraw docstring

last-tokencljs

(last-token json-source-file)
(last-token json-source-file source-file)

Parameters:

  • source-file: SourceFile | undefined

Returns: Node | undefined

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

**Returns:** `Node | undefined`
sourceraw docstring

leading-trivia-widthcljs

(leading-trivia-width json-source-file)
(leading-trivia-width json-source-file source-file)

Parameters:

  • source-file: SourceFile | undefined

Returns: number

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

**Returns:** `number`
sourceraw docstring

lib-reference-directivescljs

(lib-reference-directives json-source-file)

Returns: readonly FileReference[]

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

line-and-character-of-positioncljs

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

Parameters:

  • pos: number

Returns: LineAndCharacter

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

**Returns:** `LineAndCharacter`
sourceraw docstring

line-end-of-positioncljs

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

Parameters:

  • pos: number

Returns: number

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

**Returns:** `number`
sourceraw docstring

line-startscljs

(line-starts json-source-file)

Returns: readonly number[]

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

module-namecljs

(module-name json-source-file)

Returns: string | undefined

**Returns:** `string | undefined`
sourceraw docstring

parentcljs

(parent json-source-file)

Returns: Node

**Returns:** `Node`
sourceraw docstring

poscljs

(pos json-source-file)

Returns: number

**Returns:** `number`
sourceraw docstring

position-of-line-and-charactercljs

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

Parameters:

  • line: number
  • character: number

Returns: number

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

**Returns:** `number`
sourceraw docstring

referenced-filescljs

(referenced-files json-source-file)

Returns: readonly FileReference[]

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

set-amd-dependencies!cljs

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

set-file-name!cljs

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

set-has-no-default-lib!cljs

(set-has-no-default-lib! json-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.
sourceraw docstring

set-implied-node-format!cljs

(set-implied-node-format! json-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.
sourceraw docstring

set-is-declaration-file!cljs

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

set-language-variant!cljs

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

set-language-version!cljs

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

set-lib-reference-directives!cljs

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

set-module-name!cljs

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

set-referenced-files!cljs

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

set-text!cljs

(set-text! json-source-file value)
source

set-type-reference-directives!cljs

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

source-filecljs

(source-file json-source-file)

Returns: SourceFile

**Returns:** `SourceFile`
sourceraw docstring

startcljs

(start json-source-file)
(start json-source-file source-file)
(start json-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`
sourceraw docstring

statementscljs

(statements json-source-file)

Returns: NodeArray<JsonObjectExpressionStatement>

**Returns:** `NodeArray<JsonObjectExpressionStatement>`
sourceraw docstring

textcljs

(text json-source-file)

Returns: string

**Returns:** `string`
sourceraw docstring

type-reference-directivescljs

(type-reference-directives json-source-file)

Returns: readonly FileReference[]

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

updatecljs

(update json-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`
sourceraw docstring

widthcljs

(width json-source-file)
(width json-source-file source-file)

Parameters:

  • source-file: SourceFileLike | undefined

Returns: number

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

**Returns:** `number`
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close