LogoAntiRaid

@antiraid-ext/settings

API reference for @antiraid-ext/settings

@antiraid-ext/settings

Functions

stringColumnType

Function Signature
function stringColumnType(type: "Scalar" | "Array", min_length: number?, max_length: number?, allowed_values: {string}, kind: string, suggestions: {string}?) -> settings.ColumnType end

Arguments

type

Union with variants:

Variant 1
"Scalar"
Variant 2
"Array"

min_length

This field is optional and may not be specified

number?

max_length

This field is optional and may not be specified

number?

allowed_values

{string}

kind

string

suggestions

This field is optional and may not be specified

{string}?

Returns

ret1

settings.ColumnType

integerColumnType

Function Signature
function integerColumnType(type: "Scalar" | "Array") -> settings.ColumnType end

Arguments

type

Union with variants:

Variant 1
"Scalar"
Variant 2
"Array"

Returns

ret1

settings.ColumnType

floatColumnType

Function Signature
function floatColumnType(type: "Scalar" | "Array") -> settings.ColumnType end

Arguments

type

Union with variants:

Variant 1
"Scalar"
Variant 2
"Array"

Returns

ret1

settings.ColumnType

bitFlagColumnType

Function Signature
function bitFlagColumnType(type: "Scalar" | "Array", values: {
		[string]: number
	}) -> settings.ColumnType end

Arguments

type

Union with variants:

Variant 1
"Scalar"
Variant 2
"Array"

values

PropTypeDescription
[string]
-

Returns

ret1

settings.ColumnType

booleanColumnType

Function Signature
function booleanColumnType(type: "Scalar" | "Array") -> settings.ColumnType end

Arguments

type

Union with variants:

Variant 1
"Scalar"
Variant 2
"Array"

Returns

ret1

settings.ColumnType

jsonColumnType

Function Signature
function jsonColumnType(type: "Scalar" | "Array", style: string?) -> settings.ColumnType end

Arguments

type

Union with variants:

Variant 1
"Scalar"
Variant 2
"Array"

style

This field is optional and may not be specified

string?

Returns

ret1

settings.ColumnType

columnCreatedAt

Common fields

Function Signature
-- Common fields
function columnCreatedAt() -> settings.Column end

Returns

ret1

settings.Column

columnCreatedBy

Function Signature
function columnCreatedBy() -> settings.Column end

Returns

ret1

settings.Column

columnLastUpdatedAt

Function Signature
function columnLastUpdatedAt() -> settings.Column end

Returns

ret1

settings.Column

columnLastUpdatedBy

Function Signature
function columnLastUpdatedBy() -> settings.Column end

Returns

ret1

settings.Column

assertString

assertX functions

Asserts that the value is a string and returns it.

Function Signature
-- assertX functions
--- Asserts that the value is a string and returns it.
function assertString(what: string, value: any) -> string end

Arguments

what

string

value

any

Returns

ret1

string

assertStringChoices

Asserts that the value is a string and one of the choices.

Function Signature
--- Asserts that the value is a string and one of the choices.
function assertStringChoices(what: string, value: any, choices: {string}) -> string end

Arguments

what

string

value

any

choices

{string}

Returns

ret1

string

assertInteger

Asserts that the value is an integer and returns it.

Function Signature
--- Asserts that the value is an integer and returns it.
function assertInteger(what: string, value: any) -> number end

Arguments

what

string

value

any

Returns

ret1

number

assertFloat

Asserts that the value is a float and returns it.

Function Signature
--- Asserts that the value is a float and returns it.
function assertFloat(what: string, value: any) -> number end

Arguments

what

string

value

any

Returns

ret1

number

assertBoolean

Asserts that the value is a boolean and returns it.

Function Signature
--- Asserts that the value is a boolean and returns it.
function assertBoolean(what: string, value: any) -> boolean end

Arguments

what

string

value

any

Returns

ret1

boolean

assertStringArray

Asserts that the value is an array of strings and returns it.

Function Signature
--- Asserts that the value is an array of strings and returns it.
function assertStringArray(what: string, value: any) -> {string} end

Arguments

what

string

value

any

Returns

ret1

{string}

assertIntegerArray

Asserts that the value is an array of integers and returns it.

Function Signature
--- Asserts that the value is an array of integers and returns it.
function assertIntegerArray(what: string, value: any) -> {number} end

Arguments

what

string

value

any

Returns

ret1

{number}

assertFloatArray

Asserts that the value is an array of floats and returns it.

Function Signature
--- Asserts that the value is an array of floats and returns it.
function assertFloatArray(what: string, value: any) -> {number} end

Arguments

what

string

value

any

Returns

ret1

{number}

assertBooleanArray

Asserts that the value is an array of booleans and returns it.

Function Signature
--- Asserts that the value is an array of booleans and returns it.
function assertBooleanArray(what: string, value: any) -> {boolean} end

Arguments

what

string

value

any

Returns

ret1

{boolean}

Last updated on