Functions — github.com/TypeStrong/typedoc

hub / github.com/TypeStrong/typedoc / functions

Functions2,021 in github.com/TypeStrong/typedoc

⨍ Functions 2,021◇ Types & classes 904

↓ 169 callersMethodpush

(types: SomeType[])

src/lib/converter/plugins/TypePlugin.ts:136

↓ 77 callersMethodget

(key: K)

src/lib/utils-common/map.ts:6

↓ 60 callersMethodgetValue

(name: string)

src/lib/utils/options/options.ts:283

↓ 59 callersMethodadd

(file: T)

src/test/fs-fixture-builder.ts:63

↓ 58 callersMethodhas

(key: K)

src/lib/utils-common/map.ts:39

↓ 58 callersFunctionnormalizePath

(path: string)

src/lib/utils/paths.ts:149

↓ 57 callersMethodwarn

(text: string, ...args: [MinimalNode?] | [number, MinimalSourceFile])

src/lib/utils-common/logger.ts:104

↓ 56 callersMethodset

(key: K, value: V)

src/lib/utils-common/map.ts:30

↓ 51 callersFunctionjoin

( joiner: FormatterNode, list: readonly T[], cb: (x: T) => FormatterNode, )

src/lib/output/formatter.tsx:80

↓ 49 callersFunctionequal

(a: T, b: T)

src/test/converter2/issues/gh2444.ts:5

↓ 47 callersMethodentries

()

src/lib/utils-common/map.ts:60

↓ 41 callersMethoderror

(text: string, ...args: [MinimalNode?] | [number, MinimalSourceFile])

src/lib/utils-common/logger.ts:136

↓ 38 callersMethodforEach

( callbackfn: (value: V, key: K, map: StableKeyMap<K, V>) => void, thisArg?: any, )

src/lib/utils-common/map.ts:51

↓ 38 callersFunctionresolve

(from: NormalizedPath, to: NormalizedPath)

src/lib/utils-common/path.ts:143

↓ 34 callersMethodwithScope

(scope: Reflection)

src/lib/converter/context.ts:438

↓ 32 callersMethodtype

( type: SomeType | undefined, where: TypeContext, options: { topLevelLinks: boolean }

src/lib/output/formatter.tsx:730

↓ 31 callersFunctionassert

(x: unknown, message = "Assertion failed")

src/lib/utils-common/general.ts:46

↓ 30 callersMethodon

* Subscribe for a general event by name. * * @event * @param event The name of the event to subscribe for. * @param handler The ha

src/test/converter/class/events-overloads.ts:14

↓ 30 callersMethodsetValue

(name: string, value: unknown, configPath?: string)

src/lib/utils/options/options.ts:314

↓ 30 callersMethodtrigger

* Emits an event to all currently subscribed listeners. * @param event the event to emit. * @param args any arguments required for the event

src/lib/utils-common/events.ts:60

↓ 29 callersFunctionsimpleElement

(element: JSX.Element)

src/lib/output/formatter.tsx:48

↓ 27 callersMethodtoObject

( item: T, obj: Partial<ModelToObject<T>>, serializer: Serializer, )

src/lib/serialization/components.ts:24

↓ 26 callersMethodgetSourceFile

()

src/lib/utils-common/minimalSourceFile.ts:16

↓ 26 callersMethodkeys

()

src/lib/utils-common/map.ts:64

↓ 25 callersMethodisDeclaration

()

src/lib/models/DeclarationReflection.ts:164

↓ 24 callersMethodfinalizeDeclarationReflection

(reflection: DeclarationReflection)

src/lib/converter/context.ts:252

↓ 23 callersMethoddelete

(key: K)

src/lib/utils-common/map.ts:47

↓ 23 callersMethodgetDeclarations

* Gets all declared options.

src/lib/utils/options/options.ts:251

↓ 23 callersFunctionnodes

(...content: FormatterNode[])

src/lib/output/formatter.tsx:69

↓ 22 callersFunctionnicePath

(absPath: string)

src/lib/utils/paths.ts:128

↓ 22 callersMethodverbose

* Log the given verbose message. * * @param text The message that should be logged.

src/lib/utils-common/logger.ts:84

↓ 21 callersMethodcreateDeclarationReflection

( kind: ReflectionKind, symbol: ts.Symbol | undefined, exportSymbol: ts.Symbol | undef

src/lib/converter/context.ts:168

↓ 21 callersMethodvalidate

(project: ProjectReflection)

src/lib/application.ts:712

↓ 20 callersMethodgetReflectionById

* Gets the reflection registered for the given reflection ID, or undefined if it is not present * in the project.

src/lib/models/ProjectReflection.ts:333

↓ 20 callersMethodsetFlag

(flag: ReflectionFlag, set: boolean)

src/lib/models/Reflection.ts:132

↓ 20 callersMethodtoString

* Return a string representation of this reflection.

src/lib/models/ParameterReflection.ts:39

↓ 19 callersFunctionOption

(name: K)

src/lib/utils/options/options.ts:457

↓ 19 callersMethodconvertType

( context: Context, type: TType, serializedNode: TNode, originalNode: ts.TypeN

src/lib/converter/types.ts:50

↓ 19 callersFunctiondirname

(path: NormalizedPath)

src/lib/utils-common/path.ts:34

↓ 19 callersMethodgetTag

* Return the first tag with the given name. * * @param tagName The name of the tag to look for. * @returns The found tag or undefined.

src/lib/models/Comment.ts:592

↓ 19 callersMethodreviveType

(obj: JSONOutput.SomeType | undefined)

src/lib/serialization/deserializer.ts:399

↓ 18 callersMethodexpectNoOtherMessages

()

src/test/TestLogger.ts:44

↓ 18 callersMethodhasModifier

* Test whether this comment contains a tag with the given name. * * @param tagName The name of the tag to look for. * @returns TRUE wh

src/lib/models/Comment.ts:578

↓ 18 callersMethodisDocument

()

src/lib/models/DocumentReflection.ts:54

↓ 17 callersFunctionassertNever

(x: never)

src/lib/utils-common/general.ts:40

↓ 17 callersMethodcombineDisplayParts

* Debugging utility for combining parts into a simple string. Not suitable for * rendering, but can be useful in tests.

src/lib/models/Comment.ts:174

↓ 17 callersMethodisProject

* Return whether this reflection is the root / project reflection.

src/lib/models/ProjectReflection.ts:98

↓ 17 callersMethodlog

(message: string, level: LogLevel)

src/test/TestLogger.ts:57

↓ 17 callersMethodread

* Read options from the reader's source and place them in the options parameter. * Options without a declared name may be treated as if they were

src/lib/utils/options/options.ts:59

↓ 17 callersMethodvalues

()

src/lib/utils-common/map.ts:70

↓ 16 callersMethodconsume

()

src/lib/utils/html.ts:205

↓ 16 callersMethodregisterReflection

* Register a newly generated reflection. All created reflections should be * passed to this method to ensure that the project helper functions wo

src/lib/converter/context.ts:321

↓ 16 callersFunctionspace

()

src/lib/output/formatter.tsx:42

↓ 15 callersMethodaddEventListener

(type: string, callback: IEventListener<T>)

src/frontend/typedoc/EventTarget.ts:11

↓ 15 callersMethodgetProperties

()

src/lib/models/DeclarationReflection.ts:199

↓ 15 callersFunctionreadFile

(file: string)

src/lib/utils/fs.ts:31

↓ 15 callersMethodtoString

* Print the version number.

src/lib/application.ts:811

↓ 14 callersMethodexpectMessage

(message: string)

src/test/TestLogger.ts:21

↓ 14 callersMethodhasFlag

(flag: ReflectionFlag)

src/lib/models/Reflection.ts:61

↓ 13 callersMethodisSet

(name: string)

src/lib/utils/options/options.ts:261

↓ 13 callersFunctionrelative

(from: NormalizedPath, to: NormalizedPath)

src/lib/utils-common/path.ts:70

↓ 13 callersMethodresolve

* Resolve the project within the given context. * * @param context The context object describing the current state the converter is in.

src/lib/converter/converter.ts:623

↓ 12 callersMethodaddFile

(...args: Parameters<typeof file>)

src/test/fs-fixture-builder.ts:64

↓ 12 callersFunctionclassNames

(names: Record<string, boolean | null | undefined>, extraCss?: string)

src/lib/output/themes/lib.tsx:75

↓ 12 callersMethodclear

()

src/test/converter/interface/interface-implementation.ts:48

↓ 12 callersFunctioncreateSignature

( context: Context, kind: | ReflectionKind.CallSignature | ReflectionKind.ConstructorS

src/lib/converter/factories/signature.ts:52

↓ 12 callersMethodfromObject

(d: Deserializer, o: T)

src/lib/serialization/deserializer.ts:48

↓ 12 callersMethodgetSymbolAtLocation

(node: ts.Node)

src/lib/converter/context.ts:140

↓ 12 callersMethodnewId

()

src/lib/output/formatter.tsx:726

↓ 11 callersFunctionfilterMap

( iter: Iterable<T> | undefined, fn: (item: T) => U | undefined, )

src/lib/utils-common/array.ts:135

↓ 11 callersMethodgetCompilerOptions

* Gets the set compiler options.

src/lib/utils/options/options.ts:364

↓ 11 callersMethodgetFullUrl

* Get the full URL to the target. In TypeDoc's default router this * is equivalent to `relativeUrl(project, refl)`, but this might not be *

src/lib/output/router.ts:108

↓ 11 callersFunctiongroup

(id: number, content: FormatterNode[])

src/lib/output/formatter.tsx:66

↓ 11 callersFunctionindent

(content: FormatterNode[])

src/lib/output/formatter.tsx:63

↓ 11 callersFunctionquery

( project: ProjectReflection, name: string, )

src/test/utils.ts:15

↓ 11 callersMethodurlTo

(refl: Reflection)

src/lib/output/formatter.tsx:722

↓ 10 callersMethodaddJsonFile

(...args: Parameters<typeof jsonFile>)

src/test/fs-fixture-builder.ts:66

↓ 10 callersMethodconvert

(context: Context, node: TNode)

src/lib/converter/types.ts:45

↓ 10 callersMethodgetLineAndCharacterOfPosition

(pos: number)

src/lib/utils-common/minimalSourceFile.ts:42

↓ 10 callersMethodlog

* Print a log message. * * @param _message The message itself. * @param level The urgency of the log message.

src/lib/utils-common/logger.ts:147

↓ 10 callersMethodreset

()

src/test/TestLogger.ts:15

↓ 10 callersFunctionspaceOrLine

()

src/lib/output/formatter.tsx:60

↓ 10 callersFunctionwriteFile

(fileName: string, data: string)

src/lib/utils/fs.ts:81

↓ 9 callersMethodall

* Analogous to `Promise.all`. * * @param values an array that may contain `CancellablePromise`s, promises, * thenables, and resolved va

example/src/classes/CancellablePromise.ts:313

↓ 9 callersMethoddefer

* Defers work until the initial pass of serialization has been completed. * This can be used to set up references which cannot be immediately res

src/lib/serialization/deserializer.ts:450

↓ 9 callersMethoddeserializeDisplayParts

( de: Deserializer, parts: JSONOutput.CommentDisplayPart[], )

src/lib/models/Comment.ts:248

↓ 9 callersMethodgetAnchor

* Gets an anchor for this target within its containing page. * May be undefined if this target owns its own page.

src/lib/output/router.ts:79

↓ 9 callersMethodgetChildByName

(arg: string | string[])

src/lib/models/ReferenceReflection.ts:78

↓ 9 callersMethodgetComment

(symbol: ts.Symbol, kind: ReflectionKind)

src/lib/converter/context.ts:383

↓ 9 callersFunctiongetCommonDirectory

(files: readonly string[])

src/lib/utils/paths.ts:102

↓ 9 callersFunctiongetConverter2App

()

src/test/programs.ts:130

↓ 9 callersFunctiongetKindClass

(refl: Reflection)

src/lib/output/themes/lib.tsx:36

↓ 9 callersMethodgetReflectionClasses

(reflection: Reflection)

src/lib/output/themes/default/DefaultTheme.tsx:98

↓ 9 callersFunctionhasAllFlags

(flags: number, check: number)

src/lib/utils-common/enum.ts:17

↓ 9 callersMethodhasUrl

* Can be used to check if the target can be linked to.

src/lib/output/router.ts:67

↓ 9 callersFunctionisAbsolute

(from: NormalizedPath)

src/lib/utils-common/path.ts:153

↓ 9 callersMethodserializeDisplayParts

( parts: CommentDisplayPart[] | undefined, )

src/lib/models/Comment.ts:214

↓ 9 callersFunctiontempdirProject

(options: string | Partial<ProjectOptions> = "")

src/test/fs-fixture-builder.ts:109

↓ 8 callersFunctionanchorIcon

(context: DefaultThemeRenderContext, anchor: string | undefined)

src/lib/output/themes/default/partials/anchor-icon.tsx:5

↓ 8 callersMethodcloneDisplayParts

* Helper utility to clone {@link Comment#summary} or {@link CommentTag#content}

src/lib/models/Comment.ts:200

next →1–100 of 2,021, ranked by callers