dots.typescript.function-like-declaration-base

Liking cljdoc? Tell your friends :D

ClojureScript only.

Several node kinds share function-like features such as a signature, a name, and a body. These nodes should extend FunctionLikeDeclarationBase. Examples:

FunctionDeclaration
MethodDeclaration
AccessorDeclaration

Several node kinds share function-like features such as a signature,
a name, and a body. These nodes should extend FunctionLikeDeclarationBase.
Examples:
- FunctionDeclaration
- MethodDeclaration
- AccessorDeclaration

raw docstring

asterisk-token^cljs

(asterisk-token function-like-declaration-base)

Returns: AsteriskToken | undefined

**Returns:** `AsteriskToken | undefined`

source raw docstring

body^cljs

(body function-like-declaration-base)

Returns: Expression | Block | undefined

**Returns:** `Expression | Block | undefined`

source raw docstring

child-at^cljs

(child-at function-like-declaration-base index)

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

(child-count function-like-declaration-base source-file)

Parameters:

source-file: SourceFile | undefined

Returns: number

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

**Returns:** `number`

source raw docstring

children^cljs

(children function-like-declaration-base)

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

Parameters:

source-file: SourceFile | undefined

Returns: Node[]

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

**Returns:** `Node[]`

source raw docstring

end^cljs

(end function-like-declaration-base)

Returns: number

**Returns:** `number`

source raw docstring

exclamation-token^cljs

(exclamation-token function-like-declaration-base)

Returns: ExclamationToken | undefined

**Returns:** `ExclamationToken | undefined`

source raw docstring

first-token^cljs

(first-token function-like-declaration-base)

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

Parameters:

source-file: SourceFile | undefined

Returns: Node | undefined

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

**Returns:** `Node | undefined`

source raw docstring

flags^cljs

(flags function-like-declaration-base)

Returns: NodeFlags

**Returns:** `NodeFlags`

source raw docstring

for-each-child^cljs

(for-each-child function-like-declaration-base cb-node)

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

Returns: number

**Returns:** `number`

source raw docstring

full-text^cljs

(full-text function-like-declaration-base)

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

Parameters:

source-file: SourceFile | undefined

Returns: string

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

**Returns:** `string`

source raw docstring

full-width^cljs

(full-width function-like-declaration-base)

Returns: number

**Returns:** `number`

source raw docstring

get-end^cljs

(get-end function-like-declaration-base)

Returns: number

**Returns:** `number`

source raw docstring

kind^cljs

(kind function-like-declaration-base)

**Returns:** `SyntaxKind.MethodSignature | SyntaxKind.MethodDeclaration | SyntaxKind.Constructor | SyntaxKind.GetAccessor | SyntaxKind.SetAccessor | SyntaxKind.CallSignature | SyntaxKind.ConstructSignature | ... 6 more ... | SyntaxKind.JSDocFunctionType`

source raw docstring

last-token^cljs

(last-token function-like-declaration-base)

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

(leading-trivia-width function-like-declaration-base source-file)

Parameters:

source-file: SourceFile | undefined

Returns: number

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

**Returns:** `number`

source raw docstring

name^cljs

(name function-like-declaration-base)

Returns: PropertyName | undefined

**Returns:** `PropertyName | undefined`

source raw docstring

parameters^cljs

(parameters function-like-declaration-base)

Returns: NodeArray<ParameterDeclaration>

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

source raw docstring

parent^cljs

(parent function-like-declaration-base)

Returns: Node

**Returns:** `Node`

source raw docstring

pos^cljs

(pos function-like-declaration-base)

Returns: number

**Returns:** `number`

source raw docstring

question-token^cljs

(question-token function-like-declaration-base)

Returns: QuestionToken | undefined

**Returns:** `QuestionToken | undefined`

source raw docstring

source-file^cljs

(source-file function-like-declaration-base)

Returns: SourceFile

**Returns:** `SourceFile`

source raw docstring

start^cljs

(start function-like-declaration-base)

(start function-like-declaration-base source-file)

(start function-like-declaration-base 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 function-like-declaration-base)

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

Parameters:

source-file: SourceFile | undefined

Returns: string

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

**Returns:** `string`

source raw docstring

type^cljs

(type function-like-declaration-base)

Returns: TypeNode | undefined

**Returns:** `TypeNode | undefined`

source raw docstring

type-parameters^cljs

(type-parameters function-like-declaration-base)

Returns: NodeArray<TypeParameterDeclaration> | undefined

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

source raw docstring

width^cljs

(width function-like-declaration-base)

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