Options
All
  • Public
  • Public/Protected
  • All
Menu

Module renderer/core/hook

Index

Type aliases

Functions

Type aliases

Hook

Hook<T>: { fun: HookFun<T>; once: boolean }

Type parameters

  • T

Type declaration

HookFun

HookFun<T>: (arg: T) => boolean | void | Promise<boolean | void>

Type parameters

  • T

Type declaration

    • (arg: T): boolean | void | Promise<boolean | void>

    • Parameters

      • arg: T

      Returns boolean | void | Promise<boolean | void>

HookType

HookType: keyof BuildInHookTypes

HookTypeWithPayload

HookTypeWithPayload: keyof Omit<BuildInHookTypes, HookTypeWithoutPayload>

HookTypeWithoutPayload

HookTypeWithoutPayload: { [ K in keyof BuildInHookTypes]: BuildInHookTypes[K] extends never ? K : never }[keyof BuildInHookTypes]

Functions

registerHook

removeHook

triggerHook

  • triggerHook<T>(type: T): Promise<void>
  • triggerHook<T>(type: T, arg: undefined, options: { breakable: true }): Promise<void>
  • triggerHook<T>(type: T, arg: BuildInHookTypes[T]): Promise<void>
  • triggerHook<T>(type: T, arg: BuildInHookTypes[T], options: { breakable: true; ignoreError?: boolean }): Promise<boolean>
  • triggerHook<T>(type: T, arg: BuildInHookTypes[T], options?: { breakable?: false; ignoreError?: boolean }): Promise<void>

  • Trigger a hook.

    Type parameters

    Parameters

    • type: T

    Returns Promise<void>

  • Type parameters

    Parameters

    • type: T
    • arg: undefined
    • options: { breakable: true }
      • breakable: true

    Returns Promise<void>

  • Type parameters

    • T: "GLOBAL_KEYDOWN" | "GLOBAL_KEYUP" | "DEEP_LINK_OPEN" | "ACTION_BEFORE_RUN" | "ACTION_AFTER_RUN" | "THEME_CHANGE" | "EDITOR_PASTE_IMAGE" | "MARKDOWN_BEFORE_RENDER" | "VIEW_ELEMENT_CLICK" | "VIEW_ELEMENT_DBCLICK" | "VIEW_KEY_DOWN" | "VIEW_SCROLL" | "VIEW_PREVIEWER_CHANGE" | "VIEW_RENDER_IFRAME_READY" | "EXPORT_BEFORE_PREPARE" | "EXPORT_AFTER_PREPARE" | "VIEW_ON_GET_HTML_FILTER_NODE" | "TREE_NODE_SELECT" | "TREE_NODE_DBLCLICK" | "MONACO_BEFORE_INIT" | "MONACO_READY" | "EDITOR_READY" | "EDITOR_CUSTOM_EDITOR_CHANGE" | "EDITOR_CURRENT_EDITOR_CHANGE" | "EDITOR_CONTENT_CHANGE" | "DOC_CREATED" | "DOC_DELETED" | "DOC_MOVED" | "DOC_PRE_SWITCH" | "DOC_BEFORE_SAVE" | "DOC_SAVED" | "DOC_BEFORE_SWITCH" | "DOC_SWITCHING" | "DOC_SWITCHED" | "DOC_SWITCH_FAILED" | "DOC_CHANGED" | "I18N_CHANGE_LANGUAGE" | "SETTING_PANEL_BEFORE_SHOW" | "SETTING_CHANGED" | "SETTING_FETCHED" | "SETTING_BEFORE_WRITE" | "EXTENSION_READY" | "CODE_RUNNER_CHANGE" | "PLUGIN_HOOK"

    Parameters

    Returns Promise<void>

  • Type parameters

    • T: "GLOBAL_KEYDOWN" | "GLOBAL_KEYUP" | "DEEP_LINK_OPEN" | "ACTION_BEFORE_RUN" | "ACTION_AFTER_RUN" | "THEME_CHANGE" | "EDITOR_PASTE_IMAGE" | "MARKDOWN_BEFORE_RENDER" | "VIEW_ELEMENT_CLICK" | "VIEW_ELEMENT_DBCLICK" | "VIEW_KEY_DOWN" | "VIEW_SCROLL" | "VIEW_PREVIEWER_CHANGE" | "VIEW_RENDER_IFRAME_READY" | "EXPORT_BEFORE_PREPARE" | "EXPORT_AFTER_PREPARE" | "VIEW_ON_GET_HTML_FILTER_NODE" | "TREE_NODE_SELECT" | "TREE_NODE_DBLCLICK" | "MONACO_BEFORE_INIT" | "MONACO_READY" | "EDITOR_READY" | "EDITOR_CUSTOM_EDITOR_CHANGE" | "EDITOR_CURRENT_EDITOR_CHANGE" | "EDITOR_CONTENT_CHANGE" | "DOC_CREATED" | "DOC_DELETED" | "DOC_MOVED" | "DOC_PRE_SWITCH" | "DOC_BEFORE_SAVE" | "DOC_SAVED" | "DOC_BEFORE_SWITCH" | "DOC_SWITCHING" | "DOC_SWITCHED" | "DOC_SWITCH_FAILED" | "DOC_CHANGED" | "I18N_CHANGE_LANGUAGE" | "SETTING_PANEL_BEFORE_SHOW" | "SETTING_CHANGED" | "SETTING_FETCHED" | "SETTING_BEFORE_WRITE" | "EXTENSION_READY" | "CODE_RUNNER_CHANGE" | "PLUGIN_HOOK"

    Parameters

    • type: T
    • arg: BuildInHookTypes[T]
    • options: { breakable: true; ignoreError?: boolean }
      • breakable: true
      • Optional ignoreError?: boolean

    Returns Promise<boolean>

  • Type parameters

    • T: "GLOBAL_KEYDOWN" | "GLOBAL_KEYUP" | "DEEP_LINK_OPEN" | "ACTION_BEFORE_RUN" | "ACTION_AFTER_RUN" | "THEME_CHANGE" | "EDITOR_PASTE_IMAGE" | "MARKDOWN_BEFORE_RENDER" | "VIEW_ELEMENT_CLICK" | "VIEW_ELEMENT_DBCLICK" | "VIEW_KEY_DOWN" | "VIEW_SCROLL" | "VIEW_PREVIEWER_CHANGE" | "VIEW_RENDER_IFRAME_READY" | "EXPORT_BEFORE_PREPARE" | "EXPORT_AFTER_PREPARE" | "VIEW_ON_GET_HTML_FILTER_NODE" | "TREE_NODE_SELECT" | "TREE_NODE_DBLCLICK" | "MONACO_BEFORE_INIT" | "MONACO_READY" | "EDITOR_READY" | "EDITOR_CUSTOM_EDITOR_CHANGE" | "EDITOR_CURRENT_EDITOR_CHANGE" | "EDITOR_CONTENT_CHANGE" | "DOC_CREATED" | "DOC_DELETED" | "DOC_MOVED" | "DOC_PRE_SWITCH" | "DOC_BEFORE_SAVE" | "DOC_SAVED" | "DOC_BEFORE_SWITCH" | "DOC_SWITCHING" | "DOC_SWITCHED" | "DOC_SWITCH_FAILED" | "DOC_CHANGED" | "I18N_CHANGE_LANGUAGE" | "SETTING_PANEL_BEFORE_SHOW" | "SETTING_CHANGED" | "SETTING_FETCHED" | "SETTING_BEFORE_WRITE" | "EXTENSION_READY" | "CODE_RUNNER_CHANGE" | "PLUGIN_HOOK"

    Parameters

    • type: T
    • arg: BuildInHookTypes[T]
    • Optional options: { breakable?: false; ignoreError?: boolean }
      • Optional breakable?: false
      • Optional ignoreError?: boolean

    Returns Promise<void>

Generated using TypeDoc