Skip to content

Scanner Module

github-actions[bot] edited this page Jun 25, 2022 · 251 revisions

Scanner module for Neorg.

This module is an implementation of a scanner that can be used anywhere TS can't be used.

Overview

Usage

How to Apply

  • To manually load the module, place this code in your Neorg setup:
    ["core.scanner"] = {
       config = { -- Note that this table is optional and doesn't need to be provided
           -- Configuration here
       }
    }
    Consult the configuration section to see how you can configure core.scanner to your liking.

Configuration

This module exposes no customization options.

Developer Usage

Public API

This segment will detail all of the functions core.scanner exposes. All of these functions reside in the public table.

  • initialize_new
  • end_session
  • lookahead
  • lookbehind
  • current
  • halt
  • advance
  • skip
  • mark_end
  • backtrack

Examples

None Provided

Extra Info

Version

This module supports at least version 0.0.11. The current Neorg version is 0.0.11.

Imports

This module does not import any other files.

Requires

This module does not require any other modules to operate.

Required by

This module isn't required by any other module.