dots.typescript.declaration

Liking cljdoc? Tell your friends :D

ClojureScript only.

child-at
child-count
children
end
first-token
flags
for-each-child
full-start
full-text
full-width
get-end
kind
last-token
leading-trivia-width
parent
pos
source-file
start
text
width

child-at^cljs

(child-at declaration index)

(child-at declaration 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 declaration)

(child-count declaration source-file)

Parameters:

source-file: SourceFile | undefined

Returns: number

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

**Returns:** `number`

source raw docstring

children^cljs

(children declaration)

(children declaration source-file)

Parameters:

source-file: SourceFile | undefined

Returns: Node[]

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

**Returns:** `Node[]`

source raw docstring

end^cljs

(end declaration)

Returns: number

**Returns:** `number`

source raw docstring

first-token^cljs

(first-token declaration)

(first-token declaration source-file)

Parameters:

source-file: SourceFile | undefined

Returns: Node | undefined

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

**Returns:** `Node | undefined`

source raw docstring

flags^cljs

(flags declaration)

Returns: NodeFlags

**Returns:** `NodeFlags`

source raw docstring

for-each-child^cljs

(for-each-child declaration cb-node)

(for-each-child declaration 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 declaration)

Returns: number

**Returns:** `number`

source raw docstring

full-text^cljs

(full-text declaration)

(full-text declaration source-file)

Parameters:

source-file: SourceFile | undefined

Returns: string

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

**Returns:** `string`

source raw docstring

full-width^cljs

(full-width declaration)

Returns: number

**Returns:** `number`

source raw docstring

get-end^cljs

(get-end declaration)

Returns: number

**Returns:** `number`

source raw docstring

kind^cljs

(kind declaration)

Returns: SyntaxKind

**Returns:** `SyntaxKind`

source raw docstring

last-token^cljs

(last-token declaration)

(last-token declaration 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 declaration)

(leading-trivia-width declaration source-file)

Parameters:

source-file: SourceFile | undefined

Returns: number

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

**Returns:** `number`

source raw docstring

parent^cljs

(parent declaration)

Returns: Node

**Returns:** `Node`

source raw docstring

pos^cljs

(pos declaration)

Returns: number

**Returns:** `number`

source raw docstring

source-file^cljs

(source-file declaration)

Returns: SourceFile

**Returns:** `SourceFile`

source raw docstring

start^cljs

(start declaration)

(start declaration source-file)

(start declaration 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

text^cljs

(text declaration)

(text declaration source-file)

Parameters:

source-file: SourceFile | undefined

Returns: string

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

**Returns:** `string`

source raw docstring

width^cljs

(width declaration)

(width declaration 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