luadocs/content/lua.scripts.api.manual/dtutils.string/sanitize.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

509 B

title id weight draft author
sanitize sanitize 40 false people

NAME

sanitize

SYNOPSIS

surround a string in quotes making it safe to pass as an argument

USAGE

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

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

DESCRIPTION

sanitize converts a string into a version suitable for use passing as an argument in a system command.

RETURN VALUE

result - string - a websafe string