Liking cljdoc? Tell your friends :D
ClojureScript only.

dots.typescript.function-declaration

asterisk-tokencljs

(asterisk-token function-declaration)

Returns: AsteriskToken | undefined

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

bodycljs

(body function-declaration)

Returns: Block | undefined

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

child-atcljs

(child-at function-declaration index)
(child-at function-declaration 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 function-declaration)
(child-count function-declaration source-file)

Parameters:

  • source-file: SourceFile | undefined

Returns: number

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

**Returns:** `number`
sourceraw docstring

childrencljs

(children function-declaration)
(children function-declaration source-file)

Parameters:

  • source-file: SourceFile | undefined

Returns: Node[]

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

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

endcljs

(end function-declaration)

Returns: number

**Returns:** `number`
sourceraw docstring

exclamation-tokencljs

(exclamation-token function-declaration)

Returns: ExclamationToken | undefined

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

first-tokencljs

(first-token function-declaration)
(first-token function-declaration source-file)

Parameters:

  • source-file: SourceFile | undefined

Returns: Node | undefined

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

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

flagscljs

(flags function-declaration)

Returns: NodeFlags

**Returns:** `NodeFlags`
sourceraw docstring

for-each-childcljs

(for-each-child function-declaration cb-node)
(for-each-child function-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`
sourceraw docstring

full-startcljs

(full-start function-declaration)

Returns: number

**Returns:** `number`
sourceraw docstring

full-textcljs

(full-text function-declaration)
(full-text function-declaration source-file)

Parameters:

  • source-file: SourceFile | undefined

Returns: string

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

**Returns:** `string`
sourceraw docstring

full-widthcljs

(full-width function-declaration)

Returns: number

**Returns:** `number`
sourceraw docstring

get-endcljs

(get-end function-declaration)

Returns: number

**Returns:** `number`
sourceraw docstring

kindcljs

(kind function-declaration)

Returns: SyntaxKind.FunctionDeclaration

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

last-tokencljs

(last-token function-declaration)
(last-token function-declaration 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 function-declaration)
(leading-trivia-width function-declaration source-file)

Parameters:

  • source-file: SourceFile | undefined

Returns: number

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

**Returns:** `number`
sourceraw docstring

modifierscljs

(modifiers function-declaration)

Returns: NodeArray<ModifierLike> | undefined

**Returns:** `NodeArray<ModifierLike> | undefined`
sourceraw docstring

namecljs

(name function-declaration)

Returns: Identifier | undefined

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

parameterscljs

(parameters function-declaration)

Returns: NodeArray<ParameterDeclaration>

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

parentcljs

(parent function-declaration)

Returns: Node

**Returns:** `Node`
sourceraw docstring

poscljs

(pos function-declaration)

Returns: number

**Returns:** `number`
sourceraw docstring

question-tokencljs

(question-token function-declaration)

Returns: QuestionToken | undefined

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

source-filecljs

(source-file function-declaration)

Returns: SourceFile

**Returns:** `SourceFile`
sourceraw docstring

startcljs

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

textcljs

(text function-declaration)
(text function-declaration source-file)

Parameters:

  • source-file: SourceFile | undefined

Returns: string

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

**Returns:** `string`
sourceraw docstring

typecljs

(type function-declaration)

Returns: TypeNode | undefined

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

type-parameterscljs

(type-parameters function-declaration)

Returns: NodeArray<TypeParameterDeclaration> | undefined

**Returns:** `NodeArray<TypeParameterDeclaration> | undefined`
sourceraw docstring

widthcljs

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

Keyboard shortcutsReport a problemcljdoc on GitHub
× close