@affordances/next/codegen
Classes
CodegenError
Extends
Error
Constructors
Constructor
new CodegenError(message?): CodegenError;Parameters
| Parameter | Type |
|---|---|
message? | string |
Returns
Inherited from
Error.constructor
Constructor
new CodegenError(message?, options?): CodegenError;Parameters
| Parameter | Type |
|---|---|
message? | string |
options? | ErrorOptions |
Returns
Inherited from
Error.constructor
Properties
| Property | Type | Default value | Overrides |
|---|---|---|---|
name | string | 'AffordancesCodegenError' | Error.name |
Type Aliases
RouteEntry
type RouteEntry = object;Properties
actions?
actions?: object;| Name | Type |
|---|---|
exports | object[] |
file | string |
route
route: string;state?
state?: string;Functions
findAppDir()
function findAppDir(root): string;Parameters
| Parameter | Type |
|---|---|
root | string |
Returns
string
generate()
function generate(root, options?): RouteEntry[];Parameters
| Parameter | Type |
|---|---|
root | string |
options? | { name?: string; } |
options.name? | string |
Returns
render()
function render(entries, options?): string;Parameters
| Parameter | Type |
|---|---|
entries | RouteEntry[] |
options? | { name?: string; } |
options.name? | string |
Returns
string
scan()
function scan(root): RouteEntry[];Parameters
| Parameter | Type |
|---|---|
root | string |