Scopes

Scopes are the foundation of ArkType, and one of the most powerful features for users wanting full control over configuration and to make their own keywords available fluidly within string definition syntax.

A scope is just like a scope in code- it’s a resolution space where you can define types, generics, etc. type is a actually just a method on a Scope!

Scope also has a method is called export. That method takes all the public names in your scope, and wraps them in an object called a Module so you can access them directly.

A lot of the time, if you don’t need to create additional types in your scope, you can just .export() it right away.

import { scope } from "arktype"

// Scopes are collections of types that can reference each other.
export const const types: Module<{
    package: {
        name: string;
        dependencies?: ...[];
        contributors?: {
            email: string;
            packages?: ...[];
        }[];
    };
    contributor: {
        email: string;
        packages?: ...[];
    };
}>types = scope({
	package: {
		name: "string",
		"dependencies?": "package[]",
		"contributors?": "contributor[]"
	},
	contributor: {
		// Subtypes like 'email' are inferred like 'string' but provide additional validation at runtime.
		email: "string.email",
		"packages?": "package[]"
	}
}).export()

// Cyclic types are inferred to arbitrary depth...
export type type Package = {
    name: string;
    dependencies?: any[];
    contributors?: {
        email: string;
        packages?: any[];
    }[];
}Package = typeof const types: Module<{
    package: {
        name: string;
        dependencies?: ...[];
        contributors?: {
            email: string;
            packages?: ...[];
        }[];
    };
    contributor: {
        email: string;
        packages?: ...[];
    };
}>types.package.infer

// And can validate cyclic data.
const const packageData: {
    name: string;
    dependencies?: ...[];
    contributors?: {
        email: string;
        packages?: ...[];
    }[];
}packageData: type Package = {
    name: string;
    dependencies?: any[];
    contributors?: {
        email: string;
        packages?: any[];
    }[];
}Package = {
	name: "arktype",
	dependencies: [{ name: "typescript" }],
	contributors: [{ email: "david@sharktypeio" }]
}
const packageData: {
    name: string;
    dependencies?: ...[];
    contributors?: {
        email: string;
        packages?: ...[];
    }[];
}packageData.dependencies![0].dependencies = [const packageData: {
    name: string;
    dependencies?: ...[];
    contributors?: {
        email: string;
        packages?: ...[];
    }[];
}packageData]

export const const out: {
    name: string;
    dependencies?: ...[];
    contributors?: {
        email: string;
        packages?: ...[];
    }[];
} | ArkErrorsout = const types: Module<{
    package: {
        name: string;
        dependencies?: ...[];
        contributors?: {
            email: string;
            packages?: ...[];
        }[];
    };
    contributor: {
        email: string;
        packages?: ...[];
    };
}>types.package(const packageData: {
    name: string;
    dependencies?: ...[];
    contributors?: {
        email: string;
        packages?: ...[];
    }[];
}packageData)

modules

🚧 Coming soon ™️🚧

visibility

🚧 Coming soon ™️🚧

submodules

🚧 Coming soon ™️🚧

thunks

🚧 Coming soon ™️🚧