Type Alias HelpUtils

type HelpUtils = {
getHelpMetadata(): MethodHelpDoc[];
getHelpMetadataByMethod(methodName: string): MethodHelpDoc[];
}

Index

Methods

getHelpMetadata getHelpMetadataByMethod

Methods

getHelpMetadata

getHelpMetadata(): MethodHelpDoc[]
Get all generated help metadata entries.

Returns MethodHelpDoc[]
help metadata entries
- Defined in utils/HelpUtils.ts:8

getHelpMetadataByMethod

getHelpMetadataByMethod(methodName: string): MethodHelpDoc[]
Get generated help metadata entries by method name.
Parameters
- methodName: string
  method name
Returns MethodHelpDoc[]
matching help metadata entries
- Defined in utils/HelpUtils.ts:14