luadocs/content/lua.scripts.api.manual/dtutils.string/sanitize_lua.md
Bill Ferguson b69d752221 [lua scripts] created manual from script comments
[lua scripts api] created manual from embedded library documentation

[lua api] created stub to contain lua api manual
2020-12-12 15:14:19 -05:00

522 B

title id weight draft author
sanitize_lua sanitize_lua 50 false people

NAME

sanitize_lua

SYNOPSIS

escape lua 'magic' characters from a pattern string

USAGE

local ds = require "lib/dtutils.string"
local result = ds.sanitize_lua(str)

str - string - the string that needs to be made safe

DESCRIPTION

sanitize_lua escapes lua 'magic' characters so that a string may be used in lua string/patten matching.

RETURN VALUE

result - string - a lua pattern safe string