dots.typescript.js-doc-signature

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
parameters
parent
pos
source-file
start
text
type
type-parameters
width

child-at^cljs

(child-at js-doc-signature index)

(child-at js-doc-signature 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 js-doc-signature)

(child-count js-doc-signature source-file)

Parameters:

source-file: SourceFile | undefined

Returns: number

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

**Returns:** `number`

source raw docstring

children^cljs

(children js-doc-signature)

(children js-doc-signature source-file)

Parameters:

source-file: SourceFile | undefined

Returns: Node[]

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

**Returns:** `Node[]`

source raw docstring

end^cljs

(end js-doc-signature)

Returns: number

**Returns:** `number`

source raw docstring

first-token^cljs

(first-token js-doc-signature)

(first-token js-doc-signature source-file)

Parameters:

source-file: SourceFile | undefined

Returns: Node | undefined

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

**Returns:** `Node | undefined`

source raw docstring

flags^cljs

(flags js-doc-signature)

Returns: NodeFlags

**Returns:** `NodeFlags`

source raw docstring

for-each-child^cljs

(for-each-child js-doc-signature cb-node)

(for-each-child js-doc-signature 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 js-doc-signature)

Returns: number

**Returns:** `number`

source raw docstring

full-text^cljs

(full-text js-doc-signature)

(full-text js-doc-signature source-file)

Parameters:

source-file: SourceFile | undefined

Returns: string

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

**Returns:** `string`

source raw docstring

full-width^cljs

(full-width js-doc-signature)

Returns: number

**Returns:** `number`

source raw docstring

get-end^cljs

(get-end js-doc-signature)

Returns: number

**Returns:** `number`

source raw docstring

kind^cljs

(kind js-doc-signature)

Returns: SyntaxKind.JSDocSignature

**Returns:** `SyntaxKind.JSDocSignature`

source raw docstring

last-token^cljs

(last-token js-doc-signature)

(last-token js-doc-signature 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 js-doc-signature)

(leading-trivia-width js-doc-signature source-file)

Parameters:

source-file: SourceFile | undefined

Returns: number

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

**Returns:** `number`

source raw docstring

parameters^cljs

(parameters js-doc-signature)

Returns: readonly JSDocParameterTag[]

**Returns:** `readonly JSDocParameterTag[]`

source raw docstring

parent^cljs

(parent js-doc-signature)

Returns: Node

**Returns:** `Node`

source raw docstring

pos^cljs

(pos js-doc-signature)

Returns: number

**Returns:** `number`

source raw docstring

source-file^cljs

(source-file js-doc-signature)

Returns: SourceFile

**Returns:** `SourceFile`

source raw docstring

start^cljs

(start js-doc-signature)

(start js-doc-signature source-file)

(start js-doc-signature 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 js-doc-signature)

(text js-doc-signature source-file)

Parameters:

source-file: SourceFile | undefined

Returns: string

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

**Returns:** `string`

source raw docstring

type^cljs

(type js-doc-signature)

Returns: JSDocReturnTag | undefined

**Returns:** `JSDocReturnTag | undefined`

source raw docstring

type-parameters^cljs

(type-parameters js-doc-signature)

Returns: readonly JSDocTemplateTag[] | undefined

**Returns:** `readonly JSDocTemplateTag[] | undefined`

source raw docstring

width^cljs

(width js-doc-signature)

(width js-doc-signature source-file)

Parameters:

source-file: SourceFileLike | undefined

Returns: number

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

**Returns:** `number`

source raw docstring

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

Keyboard shortcuts Report a problem cljdoc on GitHub

× close