Prism API - v2.0.0-alpha.1
    Preparing search index...

    Registry of language definitions.

    Besides plain language ids and aliases, the registry understands compound ids of the form outer:inner for meta-languages, i.e. languages that embed or produce another language (definitions with an inner key). diff:css is a diff of CSS, django:css is a Django template producing CSS, and diff:django:css is a diff of that.

    Compound ids are normalized: aliases are resolved per part, an inner language equal to the declared default is dropped (django:markupdjango) and :none on a language without a default is dropped too (diff:nonediff).

    Hierarchy (View Summary)

    Index
    aliases: Record<string, string> = {}
    cache: Record<string, any> = {}

    All imported components.

    defs: WeakMap<LanguageProto, Language> = ...
    instances: Languages = {}
    loading: Record<string, Promise<any>> = {}

    All components that are currently being loaded.

    path: string

    Path to the components, used for loading.

    prism: Prism

    A reference to the Prism instance.

    ready: Promise<any[]>
    type: string = 'language'
    • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

      The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options’s capture.

      When set to true, options’s capture prevents callback from being invoked when the event’s eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event’s eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event’s eventPhase attribute value is AT_TARGET.

      When set to true, options’s passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

      When set to true, options’s once indicates that the callback will only be invoked once after which the event listener will be removed.

      If an AbortSignal is passed for options’s signal, then the event listener will be removed when signal is aborted.

      The event listener is appended to target’s event listener list and is not appended if it has the same type, callback, and capture.

      MDN Reference

      Parameters

      • type: string
      • callback: EventListenerOrEventListenerObject
      • Optionaloptions: boolean | AddEventListenerOptions

      Returns void

    • Dispatches a synthetic event event to target and returns true if either event’s cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

      MDN Reference

      Parameters

      • event: Event

      Returns boolean

    • Get resolved language or null if it doesn’t exist If definition is loaded but not yet resolved, it will be resolved and returned.

      For compound ids (outer:inner), a derived language instance is created that embeds the inner language. This requires the outer language to be a meta-language (have an inner key) and the inner language to be loaded.

      Parameters

      Returns Language

    • Removes the event listener in target’s event listener list with the same type, callback, and options.

      MDN Reference

      Parameters

      • type: string
      • callback: EventListenerOrEventListenerObject
      • Optionaloptions: boolean | EventListenerOptions

      Returns void