@collectium/builder - API documentation

Functions

build()

function build(data: BuildParams): Promise<void>

Parameters

Parameter	Type
data	BuildParams

Returns

Promise<void>

---

buildApi()

function buildApi(__namedParameters: BuildApiParams): Promise<void>

Parameters

Parameter	Type
__namedParameters	BuildApiParams

Returns

Promise<void>

---

buildSchema()

function buildSchema(__namedParameters: BuildSchemaParams): Promise<void>

Parameters

Parameter	Type
__namedParameters	BuildSchemaParams

Returns

Promise<void>

Type Aliases

BuildApiParams

type BuildApiParams: {
  input: Awaited<ReturnType<typeof createApp>>;
  opts: {
     dts: boolean;
     md: boolean;
     schema: boolean;
    };
  output: string;
};

Type declaration

Name	Type	Description
input	Awaited<ReturnType<typeof createApp>>	Collectium Api App
opts?	{ dts: boolean; md: boolean; schema: boolean; }	-
opts.dts?	boolean	Build openapi Definition ts file Default true
opts.md?	boolean	Build markdown documentation file Default false
opts.schema?	boolean	Build openapi schema Default true
output?	string	Output dir Default 'build/api'

---

BuildBinParams

type BuildBinParams: {
  input: string;
  opts: Omit<Parameters<typeof build>[0], "input" | "output">;
  output: string;
};

Type declaration

Name	Type	Description
input	string	Api App path
opts?	Omit<Parameters<typeof build>[0], "input" | "output">	-
output?	string	Output dir

---

BuildParams

type BuildParams: {
  api: Omit<BuildApiParams, "output">;
  bin: Omit<BuildBinParams, "output">;
  output: string;
  schema: Omit<BuildSchemaParams, "output">;
};

Type declaration

Name	Type	Description
api?	Omit<BuildApiParams, "output">	-
bin?	Omit<BuildBinParams, "output">	-
output?	string	Output dir Default './build'
schema?	Omit<BuildSchemaParams, "output">	-

---

BuildSchemaParams

type BuildSchemaParams: {
  input: Collectium;
  output: string;
};

Type declaration

Name	Type	Description
input	Collectium	-
output?	string	Output dir Default 'build/schema'

References

default

Renames and re-exports build