Skip to content

Flag Types

Flag types provide boolean columns with sensible defaults.

TypeExpands To
col.flag()boolean + default(false)
col.flag(true)boolean + default(true)
schemas/auth/user.js
export default table({
id: col.id(),
is_active: col.flag(true),
is_admin: col.flag(),
email_verified: col.flag(),
accepts_marketing: col.flag(),
});

Without an argument, flags default to false:

is_featured: col.flag(); // defaults to false
is_published: col.flag(true); // defaults to true
Use CaseRecommended Default
is_activetrue
is_deletedfalse
is_verifiedfalse
is_publicfalse