Class ScriptLoader

Lua script loader with include support

Hierarchy

ScriptLoader

Index

Constructors

constructor

Methods

Constructors

constructor

new ScriptLoader(): ScriptLoader

- Defined in commands/script-loader.ts:97
Returns ScriptLoader

Methods

addPathMapping

addPathMapping(name: string, mappedPath: string): void

- Defined in commands/script-loader.ts:111
Add a script path mapping. Allows includes of the form "/utils.lua" where includes is a user defined path

Parameters
- name: string
  
  the name of the mapping. Note: do not include angle brackets
- mappedPath: string
  
  if a relative path is passed, it's relative to the caller of this function. Mapped paths are also accepted, e.g. "~/server/scripts/lua" or "/includes"
Returns void

clearCache

clearCache(): void

- Defined in commands/script-loader.ts:450
Clears the command cache

Returns void

interpolate

interpolate(file: ScriptMetadata, processed?: Set<string>): string

- Defined in commands/script-loader.ts:328
Construct the final version of a file by interpolating its includes in dependency order.

Parameters
- file: ScriptMetadata
  
  the file whose content we want to construct
- Optional processed: Set<string>
  
  a cache to keep track of which includes have already been processed
Returns string

load

load(client: RedisClient, pathname: string): Promise<void>

- Defined in commands/script-loader.ts:429
Attach all lua scripts in a given directory to a client instance

Parameters
- client: RedisClient
  
  redis client to attach script to
- pathname: string
  
  the path to the directory containing the scripts
Returns Promise<void>

loadCommand

loadCommand(filename: string, cache?: Map<string, ScriptMetadata>): Promise<Command>

- Defined in commands/script-loader.ts:351
Parameters
- filename: string
- Optional cache: Map<string, ScriptMetadata>
Returns Promise<Command>

loadScripts

loadScripts(dir?: string, cache?: Map<string, ScriptMetadata>): Promise<Command[]>

- Defined in commands/script-loader.ts:384
Load redis lua scripts. The name of the script must have the following format:

cmdName-numKeys.lua

cmdName must be in camel case format.

For example: moveToFinish-3.lua

Parameters
- Optional dir: string
- Optional cache: Map<string, ScriptMetadata>
Returns Promise<Command[]>

parseScript

parseScript(filename: string, content: string, cache?: Map<string, ScriptMetadata>): Promise<ScriptMetadata>

- Defined in commands/script-loader.ts:300
Parse a (top-level) lua script

Parameters
- filename: string
  
  the full path to the script
- content: string
  
  the content of the script
- Optional cache: Map<string, ScriptMetadata>
  
  cache
Returns Promise<ScriptMetadata>

resolvePath

resolvePath(scriptName: string, stack?: string[]): string

- Defined in commands/script-loader.ts:135
Resolve the script path considering path mappings

Parameters
- scriptName: string
  
  the name of the script
- stack: string[] = []
  
  the include stack, for nicer errors
Returns string

Generated using TypeDoc