Class Mark<Options, Storage>

constructor

• new Mark<Options = any, Storage = any>(
      config?: Partial<MarkConfig<Options, Storage>>,
  ): Mark<Options, Storage>

  Type Parameters

  • Options = any
  • Storage = any

  Parameters

  • Optionalconfig: Partial<MarkConfig<Options, Storage>>

  Returns Mark<Options, Storage>

type

configure

• configure(options?: Partial<Options>): Mark<Options, Storage>

  Parameters

  • Optionaloptions: Partial<Options>

  Returns Mark<Options, Storage>

extend

• extend<
      ExtendedOptions = Options,
      ExtendedStorage = Storage,
      ExtendedConfig = MarkConfig<ExtendedOptions, ExtendedStorage>,
  >(
      extendedConfig?:
          | (() => Partial<ExtendedConfig>)
          | Partial<ExtendedConfig> & ThisType<
              {
                  editor: Editor;
                  name: string;
                  options: ExtendedOptions;
                  storage: ExtendedStorage;
                  type: MarkType;
              },
          >,
  ): Mark<ExtendedOptions, ExtendedStorage>

  Type Parameters

  • ExtendedOptions = Options
  • ExtendedStorage = Storage
  • ExtendedConfig = MarkConfig<ExtendedOptions, ExtendedStorage>

  Parameters

  • OptionalextendedConfig:
        | (() => Partial<ExtendedConfig>)
        | Partial<ExtendedConfig> & ThisType<
            {
                editor: Editor;
                name: string;
                options: ExtendedOptions;
                storage: ExtendedStorage;
                type: MarkType;
            },
        >

  Returns Mark<ExtendedOptions, ExtendedStorage>

Staticcreate

• create<O = any, S = any>(
      config?: Partial<MarkConfig<O, S>> | (() => Partial<MarkConfig<O, S>>),
  ): Mark<O, S>

  Create a new Mark instance

  Type Parameters

  • O = any
  • S = any

  Parameters

  • Optionalconfig: Partial<MarkConfig<O, S>> | (() => Partial<MarkConfig<O, S>>)

    Mark configuration object or a function that returns a configuration object

  Returns Mark<O, S>

StatichandleExit

• handleExit(__namedParameters: { editor: Editor; mark: Mark }): boolean

  Parameters

  • __namedParameters: { editor: Editor; mark: Mark }

  Returns boolean