Skip to content

Variable: mockString ​

ts
const mockString: {
  find: (target: string, pattern: string, startIndex?: number, plain?: boolean) => Nillable<string | number>[];
  format: (base: string, ...replacements: unknown[]) => string;
  gfind: (target: string, pattern: string) => string[];
  gmatch: (target: string, pattern: string) => string[];
  gsub: (target: string, pattern: string, selector: string) => Nillable<string | number>[];
  len: (target: string) => number;
  lower: (target: string) => string;
  match: (target: string, pattern: string, init?: number) => (string | number)[];
  trim: (target: string) => string;
  trim_l: (target: string) => string;
  trim_r: (target: string) => string;
  trim_w: (target: string) => string;
  sub: Nillable<string>;
};

Mock lua global string methods. Use lua VM to get 1-1 behaviour in some cases.

Type Declaration ​

NameTypeDescription
find()(target: string, pattern: string, startIndex?: number, plain?: boolean) => Nillable<string | number>[]-
format()(base: string, ...replacements: unknown[]) => string-
gfind()(target: string, pattern: string) => string[]-
gmatch()(target: string, pattern: string) => string[]-
gsub()(target: string, pattern: string, selector: string) => Nillable<string | number>[]-
len()(target: string) => number-
lower()(target: string) => string-
match()(target: string, pattern: string, init?: number) => (string | number)[]As Lua string.match: the captures of the first match, or the whole first match without captures. Returns an empty list when nothing matches, as the engine returns a single nil.
trim()(target: string) => string-
trim_l()(target: string) => string-
trim_r()(target: string) => string-
trim_w()(target: string) => string-
sub()( target: string, start: number, end?: number) => Nillable<string>-