MCPcopy Create free account

hub / github.com/SimplrJS/ts-docs-gen / functions

Functions267 in github.com/SimplrJS/ts-docs-gen

⨍ Functions 267◇ Types & classes 198
↓ 19 callersMethodToInlineText
(render?: ReferenceRenderHandler)
packages/ts-docs-gen/src/contracts/serialized-api-item.ts:13
↓ 9 callersFunctionflagName
(name: keyof CliFlags)
packages/ts-docs-gen/src/cli/arguments.ts:19
↓ 6 callersMethodToText
(render?: ReferenceRenderHandler)
packages/ts-docs-gen/src/contracts/serialized-api-item.ts:12
↓ 4 callersMethodBuild
(entryFiles: string[])
packages/ts-docs-gen/src/builders/generator-configuration-builder.ts:98
↓ 4 callersFunctionLogWithApiItemPosition
( logLevel: LogLevel, apiItem: Contracts.ApiBaseDefinition | Contracts.ApiBaseType,
packages/ts-docs-gen/src/generator-helpers.ts:182
↓ 3 callersMethodgetKey
(itemReference: ApiItemReference)
packages/ts-docs-gen/src/registries/api-item-reference-registry.ts:7
↓ 3 callersMethodresolveProjectDirectory
()
packages/ts-docs-gen/src/builders/generator-configuration-builder.ts:25
↓ 2 callersFunctionCheckLists
(a: string[], b: string[], ignoreValues?: string[])
packages/ts-docs-gen/tests/__tests__/test-helpers.ts:7
↓ 2 callersMethodRegister
(plugin: Plugin)
packages/ts-docs-gen/src/registries/plugin-registry.ts:19
↓ 2 callersMethodToHeadingText
()
packages/ts-docs-gen/src/contracts/serialized-api-item.ts:25
↓ 2 callersMethodWriteToFiles
()
packages/ts-docs-gen/src/generator.ts:40
↓ 2 callersMethodrenderApiItem
( apiItemReference: ApiItemReference, apiItem: Contracts.ApiDefinition )
packages/ts-docs-gen/src/generator.ts:71
↓ 1 callersMethodAddEntryFile
(itemResult: PluginResult<ApiContainer>)
packages/ts-docs-gen/src/file-manager.ts:89
↓ 1 callersMethodAddItem
(itemResult: PluginResult<ApiContainer>, filePath: string)
packages/ts-docs-gen/src/file-manager.ts:126
↓ 1 callersMethodAddItem
(itemReference: ApiItemReference, value: TValue)
packages/ts-docs-gen/src/contracts/api-item-reference-registry.ts:9
↓ 1 callersMethodAddPlugins
(plugins: Plugin[])
packages/ts-docs-gen/src/builders/generator-configuration-builder.ts:91
↓ 1 callersMethodCheckApiItem
(item: TKind)
packages/ts-docs-gen/src/contracts/plugin.ts:59
↓ 1 callersMethodDefaultMessageTypeString
* public static method `DefaultMessageTypeString` comment.
packages/ts-docs-gen/tests/cases/simple-project-2/src/foo.ts:40
↓ 1 callersMethodExists
(itemReference: ApiItemReference)
packages/ts-docs-gen/src/contracts/api-item-reference-registry.ts:5
↓ 1 callersMethodGetItem
(itemReference: ApiItemReference)
packages/ts-docs-gen/src/contracts/api-item-reference-registry.ts:4
↓ 1 callersMethodGetPluginsByKind
(kind: Contracts.ApiDefinitionKind)
packages/ts-docs-gen/src/registries/plugin-registry.ts:35
↓ 1 callersFunctionMain
()
packages/ts-docs-gen/src/debug.ts:32
↓ 1 callersMethodOverrideConfiguration
* Override configuration with a new configuration object. * * @param configuration Partial configuration object.
packages/ts-docs-gen/src/builders/generator-configuration-builder.ts:70
↓ 1 callersMethodRender
(options: PluginOptions, apiItem: Contracts.ApiDefinition)
packages/ts-docs-gen/src/plugins/api-default-plugin.ts:14
↓ 1 callersMethodRender
(options: PluginOptions, apiItem: TKind)
packages/ts-docs-gen/src/contracts/plugin.ts:60
↓ 1 callersMethodSetOutputDirectory
(outputDirectory: string)
packages/ts-docs-gen/src/builders/generator-configuration-builder.ts:85
↓ 1 callersMethodSupportedApiDefinitionKind
()
packages/ts-docs-gen/src/contracts/plugin.ts:58
↓ 1 callersMethodToFilesOutput
()
packages/ts-docs-gen/src/file-manager.ts:150
↓ 1 callersMethodToHeadingText
()
packages/ts-docs-gen/src/api-items/api-definition-default.ts:47
↓ 1 callersMethodToHeadingText
()
packages/ts-docs-gen/src/api-items/definitions/api-class.ts:67
↓ 1 callersMethodToHeadingText
()
packages/ts-docs-gen/src/api-items/definitions/api-type-alias.ts:29
↓ 1 callersMethodToHeadingText
()
packages/ts-docs-gen/src/api-items/definitions/api-variable.ts:15
↓ 1 callersMethodToHeadingText
()
packages/ts-docs-gen/src/api-items/definitions/api-namespace.ts:11
↓ 1 callersMethodToHeadingText
()
packages/ts-docs-gen/src/api-items/definitions/api-accessor.ts:53
↓ 1 callersMethodToHeadingText
()
packages/ts-docs-gen/src/api-items/definitions/api-class-property.ts:18
↓ 1 callersMethodToHeadingText
()
packages/ts-docs-gen/src/api-items/definitions/api-class-method.ts:19
↓ 1 callersMethodToHeadingText
()
packages/ts-docs-gen/src/api-items/definitions/api-function.ts:12
↓ 1 callersMethodToHeadingText
()
packages/ts-docs-gen/src/api-items/definitions/api-enum.ts:47
↓ 1 callersMethodToHeadingText
()
packages/ts-docs-gen/src/api-items/definitions/api-source-file.ts:11
↓ 1 callersMethodToHeadingText
()
packages/ts-docs-gen/src/api-items/definitions/api-class-constructor.ts:13
↓ 1 callersMethodToHeadingText
(alias?: string | undefined)
packages/ts-docs-gen/src/api-items/definitions/api-interface.ts:55
↓ 1 callersMethodToText
(render: ReferenceRenderHandler = this.DefaultReferenceRenderer)
packages/ts-docs-gen/src/api-items/api-definition-default.ts:39
↓ 1 callersMethodToText
(render: ReferenceRenderHandler = this.DefaultReferenceRenderer)
packages/ts-docs-gen/src/api-items/definitions/api-class.ts:37
↓ 1 callersMethodToText
(render: ReferenceRenderHandler = this.DefaultReferenceRenderer)
packages/ts-docs-gen/src/api-items/definitions/api-type-alias.ts:20
↓ 1 callersMethodToText
(render: ReferenceRenderHandler = this.DefaultReferenceRenderer)
packages/ts-docs-gen/src/api-items/definitions/api-variable.ts:7
↓ 1 callersMethodToText
(render: ReferenceRenderHandler = this.DefaultReferenceRenderer)
packages/ts-docs-gen/src/api-items/definitions/api-accessor.ts:38
↓ 1 callersMethodToText
(render: ReferenceRenderHandler = this.DefaultReferenceRenderer)
packages/ts-docs-gen/src/api-items/definitions/api-index.ts:18
↓ 1 callersMethodToText
(render: ReferenceRenderHandler = this.DefaultReferenceRenderer)
packages/ts-docs-gen/src/api-items/definitions/api-class-property.ts:6
↓ 1 callersMethodToText
(render: ReferenceRenderHandler = this.DefaultReferenceRenderer)
packages/ts-docs-gen/src/api-items/definitions/api-class-method.ts:6
↓ 1 callersMethodToText
(render: ReferenceRenderHandler = this.DefaultReferenceRenderer)
packages/ts-docs-gen/src/api-items/definitions/api-function.ts:6
↓ 1 callersMethodToText
(render: ReferenceRenderHandler = this.DefaultReferenceRenderer)
packages/ts-docs-gen/src/api-items/definitions/api-enum.ts:24
↓ 1 callersMethodToText
(render: ReferenceRenderHandler = this.DefaultReferenceRenderer)
packages/ts-docs-gen/src/api-items/definitions/api-class-constructor.ts:6
↓ 1 callersMethodToText
(render: ReferenceRenderHandler = this.DefaultReferenceRenderer)
packages/ts-docs-gen/src/api-items/definitions/api-interface.ts:31
↓ 1 callersMethodaddItemHeadings
(headings: PluginHeading[], filePath: string)
packages/ts-docs-gen/src/file-manager.ts:99
↓ 1 callersMethodgetTimeString
* private static method `getTimeString` comment.
packages/ts-docs-gen/tests/cases/simple-project-2/src/foo.ts:33
↓ 1 callersMethodisSupportedKindsHasAny
(kinds: SupportedApiItemKindType[])
packages/ts-docs-gen/src/registries/plugin-registry.ts:15
↓ 1 callersMethodremoveBrokenLinks
(result: string[], referenceId: string)
packages/ts-docs-gen/src/file-manager.ts:121
↓ 1 callersMethodrenderConstraintTypes
(extractedData: ExtractDto, extendsItems: ApiTypes[])
packages/ts-docs-gen/src/plugins/api-interface-plugin.ts:41
↓ 1 callersMethodrenderEnumTable
(members: ApiEnumMember[])
packages/ts-docs-gen/src/plugins/api-enum-plugin.ts:19
↓ 1 callersMethodrenderPropertyMembers
(extractedData: ExtractDto, members: ApiDefinitions[])
packages/ts-docs-gen/src/plugins/api-interface-plugin.ts:65
↓ 1 callersMethodrenderTableOfContents
(containerResult: PluginResult<ApiContainer>)
packages/ts-docs-gen/src/file-manager.ts:42
↓ 1 callersMethodresolveMemberKindsList
(apiItemKind: Contracts.ApiDefinitionKind)
packages/ts-docs-gen/src/file-manager.ts:28
↓ 1 callersMethodresolveReferenceFile
(referenceId: string)
packages/ts-docs-gen/src/file-manager.ts:109
↓ 1 callersMethodresolveSerializedApiItem
( extractedData: ExtractDto, apiItem: CallableApiItem, reference: ApiItemReference
packages/ts-docs-gen/src/plugins/api-callable-plugin.ts:24
↓ 1 callersMethodresolveType
()
packages/ts-docs-gen/src/api-items/definitions/api-accessor.ts:22
MethodAddItem
(itemReference: ApiItemReference, value: TValue)
packages/ts-docs-gen/src/registries/api-item-reference-registry.ts:18
FunctionAnotherFoo
(parameter1: string, parameter2: Promise<T>)
packages/ts-docs-gen/tests/cases/simple-project-1/src/index.ts:290
FunctionApiItem
()
packages/ts-docs-gen/src/abstractions/base-api-item.ts:11
FunctionArrowFunctionConst
(a: string)
packages/ts-docs-gen/tests/cases/simple-project-1/src/index.ts:225
FunctionBar
(parameter1: string, parameter2: number)
packages/ts-docs-gen/tests/cases/simple-project-1/src/index.ts:316
MethodBooTheMessage
()
packages/ts-docs-gen/tests/cases/simple-project-2/src/boo.ts:21
FunctionCallableToSimpleString
()
packages/ts-docs-gen/src/api-items/api-callable.ts:81
FunctionCallableToString
* Example: `<TValue>(arg: TValue): void` * @param typeDefChar If empty string, return type is not shown. @default ": "
packages/ts-docs-gen/src/api-items/api-callable.ts:62
FunctionCheckApiItem
(item: TKind)
packages/ts-docs-gen/src/abstractions/base-plugin.ts:19
MethodCheckApiItem
(item: Contracts.ApiEnumDto)
packages/ts-docs-gen/src/plugins/api-enum-plugin.ts:15
MethodCheckApiItem
(item: Contracts.ApiDefinition)
packages/ts-docs-gen/src/plugins/api-class-method-plugin.ts:14
MethodConstraintType
()
packages/ts-docs-gen/src/api-items/definitions/api-type-parameter.ts:11
MethodDefaultMessage
()
packages/ts-docs-gen/tests/cases/simple-project-2/src/foo.ts:94
MethodDefaultType
()
packages/ts-docs-gen/src/api-items/definitions/api-type-parameter.ts:20
FunctionEnsureFullStop
(sentence: string, punctuationMark: string = ".")
packages/ts-docs-gen/src/generator-helpers.ts:237
MethodEnumMembers
()
packages/ts-docs-gen/src/api-items/definitions/api-enum.ts:12
MethodExists
(itemReference: ApiItemReference)
packages/ts-docs-gen/src/registries/api-item-reference-registry.ts:32
MethodExtends
()
packages/ts-docs-gen/src/api-items/definitions/api-class.ts:22
MethodExtends
()
packages/ts-docs-gen/src/api-items/definitions/api-interface.ts:22
FunctionExtractedData
()
packages/ts-docs-gen/src/abstractions/base-api-item.ts:7
FunctionFlatten
(arr: any[][])
packages/ts-docs-gen/src/utils/helpers.ts:4
FunctionFunctionConst
()
packages/ts-docs-gen/tests/cases/simple-project-1/src/index.ts:275
FunctionFunctionWithGenericReturnType
()
packages/ts-docs-gen/tests/cases/simple-project-1/src/index.ts:351
FunctionFunctionWithInitializedNumberParameter
(someParameter: number = 12)
packages/ts-docs-gen/tests/cases/simple-project-1/src/index.ts:376
FunctionFunctionWithInitializedStringParameter
(someParameter: string = "12")
packages/ts-docs-gen/tests/cases/simple-project-1/src/index.ts:380
FunctionFunctionWithIntersectionReturnType
()
packages/ts-docs-gen/tests/cases/simple-project-1/src/index.ts:363
FunctionFunctionWithMultipleParameters
(parameter1: string, parameter2: number)
packages/ts-docs-gen/tests/cases/simple-project-1/src/index.ts:306
FunctionFunctionWithMultipleTypeParameters
(parameter1: T, parameter2: P)
packages/ts-docs-gen/tests/cases/simple-project-1/src/index.ts:329
FunctionFunctionWithNoParameters
()
packages/ts-docs-gen/tests/cases/simple-project-1/src/index.ts:302
FunctionFunctionWithOneParameter
(parameter: string)
packages/ts-docs-gen/tests/cases/simple-project-1/src/index.ts:298
FunctionFunctionWithPrimitiveReturnType
()
packages/ts-docs-gen/tests/cases/simple-project-1/src/index.ts:355
FunctionFunctionWithTypeParameterConstraint
(parameter1: string, parameter2: T)
packages/ts-docs-gen/tests/cases/simple-project-1/src/index.ts:343
FunctionFunctionWithTypeParameterDefault
(parameter1: string, parameter2: T)
packages/ts-docs-gen/tests/cases/simple-project-1/src/index.ts:336
FunctionFunctionWithUnionReturnType
()
packages/ts-docs-gen/tests/cases/simple-project-1/src/index.ts:359
FunctionFunctionWithoutReturnType
(parameter1: string, parameter2: Promise<T>)
packages/ts-docs-gen/tests/cases/simple-project-1/src/index.ts:347
next →1–100 of 267, ranked by callers