#cp.is

A simple class that lets you test if a value is a particular type. Notes: for best performance, assign the specific checks you want to use to local functions. Eg:

local is_nothing = require("cp.is").nothing is_nothing(nil) == true

You can also get functions that negate the functions below by calling is.nt.XXX(...) (read: "isn't XXX"). The individual functions are not documented, but all will work as expected. Eg:

is.blank("") == true is.nt.blank("") == false

They can also be assigned directly to local values for better performance:

local isnt_blank = is.nt.blank isnt_blank(nil) == false

#API Overview

Functions - API calls offered directly by the extension


#API Documentation

#Functions

Signaturecp.is.blank(value) -> boolean
TypeFunction
DescriptionCheck if the value is a blank string value - either nil or tostring(value) == "".
Parameters
  • value - the value to check.
Returns
  • true if it matches, false if not.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp//is.lua line 222

Signaturecp.is.boolean(value) -> boolean
TypeFunction
DescriptionCheck if the value is a function.
Parameters
  • value - the value to check
Returns
  • true if it matches, false if not.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp//is.lua line 93

Signaturecp.is.callable(value) -> boolean
TypeFunction
DescriptionCheck if the value is a callable - either a function or a table with __call in it's metatable hierarchy.
Parameters
  • value - the value to check
Returns
  • true if it matches, false if not.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp//is.lua line 209

Signaturecp.is.falsey(value) -> boolean
TypeFunction
DescriptionCheck if the value is a falsey value. A value is considered to be falsey if it is nil or false.
Parameters
  • value - the value to check
Returns
  • true if it matches, false if not.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp//is.lua line 171

Signaturecp.is.fn(value) -> boolean
TypeFunction
DescriptionCheck if the value is a function.
Parameters
  • value - the value to check
Returns
  • true if it matches, false if not.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp//is.lua line 67

Signaturecp.is.instance(value, class) -> boolean
TypeFunction
DescriptionCheck if the value is an instance of the provided class table. It is considered an instance if the class is either the value itself, or is the __index or __class field of the metatable.
Parameters
  • value - the value to check
  • class - the class table to check
Returns
  • true if it is an instance.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp//is.lua line 235

Signaturecp.is.list(value) -> boolean
TypeFunction
DescriptionCheck if the value is a list.
Parameters
  • value - the value to check
Returns
  • true if it matches, false if not.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp//is.lua line 145

Signaturecp.is.nothing(value) -> boolean
TypeFunction
DescriptionCheck if the value is nil.
Parameters
  • value - the value to check
Returns
  • true if it matches, false if not.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp//is.lua line 28

Signaturecp.is.number(value) -> boolean
TypeFunction
DescriptionCheck if the value is a number.
Parameters
  • value - the value to check
Returns
  • true if it matches, false if not.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp//is.lua line 80

Signaturecp.is.object(value) -> boolean
TypeFunction
DescriptionCheck if the value is a object.
Parameters
  • value - the value to check
Returns
  • true if it matches, false if not.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp//is.lua line 132

Signaturecp.is.something(value) -> boolean
TypeFunction
DescriptionCheck if the value is not nil.
Parameters
  • value - the value to check
Returns
  • true if it matches, false if not.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp//is.lua line 41

Signaturecp.is.string(value) -> boolean
TypeFunction
DescriptionCheck if the value is a string.
Parameters
  • value - the value to check
Returns
  • true if it matches, false if not.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp//is.lua line 54

Signaturecp.is.table(value) -> boolean
TypeFunction
DescriptionCheck if the value is a table.
Parameters
  • value - the value to check
Returns
  • true if it matches, false if not.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp//is.lua line 106

Signaturecp.is.truthy(value) -> boolean
TypeFunction
DescriptionCheck if the value is a truthy value. A value is considered to be truthy if it is not nil nor false.
Parameters
  • value - the value to check
Returns
  • true if it matches, false if not.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp//is.lua line 158

Signaturecp.is.userdata(value) -> boolean
TypeFunction
DescriptionCheck if the value is a userdata object.
Parameters
  • value - the value to check
Returns
  • true if it matches, false if not.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp//is.lua line 119