Class BackgroundTokenizer

constructor

• new BackgroundTokenizer(
      tokenizer: Tokenizer,
      session?: EditSession,
  ): BackgroundTokenizer

• Creates a new BackgroundTokenizer object.

  Parameters

  • tokenizer: Tokenizer

    The tokenizer to use
  • Optionalsession: EditSession

    The editor session to associate with

  Returns BackgroundTokenizer

currentLine

doc

lines

running

states

tokenizer

_dispatchEvent

• _dispatchEvent<K extends "update">(
      eventName: K,
      ...args: Parameters<BackgroundTokenizerEvents[K]>,
  ): void

• Type Parameters

  • K extends "update"

  Parameters

  • eventName: K
  • ...args: Parameters<BackgroundTokenizerEvents[K]>

  Returns void

_emit

• _emit<K extends "update">(
      eventName: K,
      ...args: Parameters<BackgroundTokenizerEvents[K]>,
  ): void

• Type Parameters

  • K extends "update"

  Parameters

  • eventName: K
  • ...args: Parameters<BackgroundTokenizerEvents[K]>

  Returns void

_signal

• _signal<K extends "update">(
      eventName: K,
      ...args: Parameters<BackgroundTokenizerEvents[K]>,
  ): void

• Type Parameters

  • K extends "update"

  Parameters

  • eventName: K
  • ...args: Parameters<BackgroundTokenizerEvents[K]>

  Returns void

addEventListener

• addEventListener<K extends "update">(
      name: K,
      callback: BackgroundTokenizerEvents[K],
      capturing?: boolean,
  ): BackgroundTokenizerEvents[K]

• Type Parameters

  • K extends "update"

  Parameters

  • name: K
  • callback: BackgroundTokenizerEvents[K]
  • Optionalcapturing: boolean

  Returns BackgroundTokenizerEvents[K]

cleanup

• cleanup(): void

• Returns void

fireUpdateEvent

• fireUpdateEvent(firstRow: number, lastRow: number): void

• Emits the 'update' event. firstRow and lastRow are used to define the boundaries of the region to be updated.

  Parameters

  • firstRow: number

    The starting row region
  • lastRow: number

    The final row region

  Returns void

getState

• getState(row: number): string | string[]

• Returns the state of tokenization at the end of a row.

  Parameters

  • row: number

    The row to get state at

  Returns string | string[]

getTokens

• getTokens(row: number): Token[]

• Gives list of [[Token]]'s of the row. (tokens are cached)

  Parameters

  • row: number

    The row to get tokens at

  Returns Token[]

off

• off<K extends "update">(name: K, callback: BackgroundTokenizerEvents[K]): void

• Type Parameters

  • K extends "update"

  Parameters

  • name: K
  • callback: BackgroundTokenizerEvents[K]

  Returns void

on

• on<K extends "update">(
      name: K,
      callback: BackgroundTokenizerEvents[K],
      capturing?: boolean,
  ): BackgroundTokenizerEvents[K]

• Type Parameters

  • K extends "update"

  Parameters

  • name: K
  • callback: BackgroundTokenizerEvents[K]
  • Optionalcapturing: boolean

  Returns BackgroundTokenizerEvents[K]

once

• once<K extends "update">(name: K, callback: BackgroundTokenizerEvents[K]): void

• Type Parameters

  • K extends "update"

  Parameters

  • name: K
  • callback: BackgroundTokenizerEvents[K]

  Returns void

removeAllListeners

• removeAllListeners(name?: string): void

• Parameters

  • Optionalname: string

  Returns void

removeDefaultHandler

• removeDefaultHandler(name: string, callback: Function): void

• Parameters

  • name: string
  • callback: Function

  Returns void

removeEventListener

• removeEventListener<K extends "update">(
      name: K,
      callback: BackgroundTokenizerEvents[K],
  ): void

• Type Parameters

  • K extends "update"

  Parameters

  • name: K
  • callback: BackgroundTokenizerEvents[K]

  Returns void

removeListener

• removeListener<K extends "update">(
      name: K,
      callback: BackgroundTokenizerEvents[K],
  ): void

• Type Parameters

  • K extends "update"

  Parameters

  • name: K
  • callback: BackgroundTokenizerEvents[K]

  Returns void

scheduleStart

• scheduleStart(): void

• Sets pretty long delay to prevent the tokenizer from interfering with the user

  Returns void

setDefaultHandler

• setDefaultHandler(name: string, callback: Function): void

• Parameters

  • name: string
  • callback: Function

  Returns void

setDocument

• setDocument(doc: Document): void

• Sets a new document to associate with this object.

  Parameters

  • doc: Document

    The new document to associate with

  Returns void

setTokenizer

• setTokenizer(tokenizer: Tokenizer): void

• Sets a new tokenizer for this object.

  Parameters

  • tokenizer: Tokenizer

    The new tokenizer to use

  Returns void

start

• start(startRow: number): void

• Starts tokenizing at the row indicated.

  Parameters

  • startRow: number

    The row to start at

  Returns void

stop

• stop(): void

• Stops tokenizing.

  Returns void