interface Plugin
A plugin for Aleph.js application.
Properties
name?: stringname gives the plugin a name.
test: RegExptest matches the import url.
acceptHMR?: booleanacceptHMR accepts the HMR.
Methods
resolve?(url: string): resolve resolves the import url, if the external returned the compilation will skip the import url.
transform?(content: Uint8Array, url: string): Promise<>transform transforms the source content.
interface SSROptions
The options for SSR.
Properties
fallback?: stringThe fallback html dynamic routes (default is '_fallback.html').
include?: RegExp[]A list of RegExp for paths to use SSR.
exclude?: RegExp[]A list of RegExp for paths to skip SSR.
staticPaths?: string[]A list of paths for dynamic routes in SSR.
interface Config
Config for Aleph.js application.
Properties
srcDir?: stringsrcDir to put your application source code (default is '/').
outputDir?: stringoutputDir specifies the output directory for build command (default is 'dist').
baseUrl?: stringbaseUrl specifies the path prefix for the application (default is '/').
reactUrl?: stringreactUrl specifies the react download URL (default is 'https://esm.sh/react@17.0.1').
reactDomUrl?: stringreactDomUrl specifies the react-dom download URL (default is 'https://esm.sh/react-dom@17.0.1').
defaultLocale?: stringdefaultLocale specifies the default locale of the application (default is 'en').
locales?: string[]A list of locales.
ssr?: boolean | SSROptionsThe options for SSR.
plugins?: Plugin[]A list of plugin.
postcss?: A list of plugin of PostCSS.
buildTarget?: stringbuildTarget specifies the build target for tsc (possible values: 'ES2015' - 'ES2020' | 'ESNext', default is ES2015 for production and ES2018 for development).
sourceMap?: booleanEnable sourceMap in production mode (default is false).
env?: Record<string, string>env appends env variables (use Deno.env.get(key) to get an env variable)
interface APIHandler
A handler to handle api requests.
- param
reqAPIRequest object
Call Signatures
(req: APIRequest): voidinterface APIRequest extends ServerRequest
The request object from api requests.
Properties
pathname: stringparams: Record<string, string>query: URLSearchParamscookies: ReadonlyMap<string, string>Methods
status(code: number): thisstatus sets response status of the request.
addHeader(key: string, value: string): thisaddHeader adds a new value onto an existing response header of the request, or
adds the header if it does not already exist.
setHeader(key: string, value: string): thissetHeader sets a new value for an existing response header of the request, or adds
the header if it does not already exist.
removeHeader(key: string): thisremoveHeader removes the value for an existing response header of the request.
send(data: string | Uint8Array | ArrayBuffer, contentType?: string): Promise<void>send replies to the request with any content with type
json(data: any): Promise<void>json replies to the request with a json content
decodeBody(type: ): Promise<string>decodeBody will return a string, a form-data or any json object
decodeBody(type: ): Promise<any>decodeBody(type: ): Promise<FormDataBody>interface RouterURL
The Router object of the application routing, you can access it with useRouter().
Properties
locale: stringpathname: stringpagePath: stringparams: Record<string, string>query: URLSearchParamsinterface FormDataBody
The form data body
Properties
fields: Record<string, string>files: FormFile[]Methods
get(key: string): string | undefinedgetFile(key: string): FormFile | undefinedinterface FormFile
The form file data
Properties
name: stringcontent: Uint8ArraycontentType: stringfilename: stringsize: numberdeno doc types.ts --json
[
{
"kind": "interface",
"name": "Plugin",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 6,
"col": 0
},
"jsDoc": "A plugin for **Aleph.js** application.",
"interfaceDef": {
"extends": [],
"methods": [
{
"name": "resolve",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 14,
"col": 4
},
"jsDoc": "`resolve` resolves the import url, if the `external` returned the compilation will skip the import url.",
"optional": true,
"params": [
{
"kind": "identifier",
"name": "url",
"optional": false,
"tsType": {
"repr": "string",
"kind": "keyword",
"keyword": "string"
}
}
],
"returnType": {
"repr": "",
"kind": "typeLiteral",
"typeLiteral": {
"methods": [],
"properties": [
{
"name": "url",
"params": [],
"computed": false,
"optional": false,
"tsType": {
"repr": "string",
"kind": "keyword",
"keyword": "string"
},
"typeParams": []
},
{
"name": "external",
"params": [],
"computed": false,
"optional": true,
"tsType": {
"repr": "boolean",
"kind": "keyword",
"keyword": "boolean"
},
"typeParams": []
}
],
"callSignatures": [],
"indexSignatures": []
}
},
"typeParams": []
},
{
"name": "transform",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 16,
"col": 4
},
"jsDoc": "`transform` transforms the source content.",
"optional": true,
"params": [
{
"kind": "identifier",
"name": "content",
"optional": false,
"tsType": {
"repr": "Uint8Array",
"kind": "typeRef",
"typeRef": {
"typeParams": null,
"typeName": "Uint8Array"
}
}
},
{
"kind": "identifier",
"name": "url",
"optional": false,
"tsType": {
"repr": "string",
"kind": "keyword",
"keyword": "string"
}
}
],
"returnType": {
"repr": "Promise",
"kind": "typeRef",
"typeRef": {
"typeParams": [
{
"repr": "",
"kind": "typeLiteral",
"typeLiteral": {
"methods": [],
"properties": [
{
"name": "code",
"params": [],
"computed": false,
"optional": false,
"tsType": {
"repr": "string",
"kind": "keyword",
"keyword": "string"
},
"typeParams": []
},
{
"name": "map",
"params": [],
"computed": false,
"optional": true,
"tsType": {
"repr": "string",
"kind": "keyword",
"keyword": "string"
},
"typeParams": []
},
{
"name": "loader",
"params": [],
"computed": false,
"optional": true,
"tsType": {
"repr": "",
"kind": "union",
"union": [
{
"repr": "js",
"kind": "literal",
"literal": {
"kind": "string",
"string": "js"
}
},
{
"repr": "ts",
"kind": "literal",
"literal": {
"kind": "string",
"string": "ts"
}
},
{
"repr": "css",
"kind": "literal",
"literal": {
"kind": "string",
"string": "css"
}
},
{
"repr": "markdown",
"kind": "literal",
"literal": {
"kind": "string",
"string": "markdown"
}
}
]
},
"typeParams": []
}
],
"callSignatures": [],
"indexSignatures": []
}
}
],
"typeName": "Promise"
}
},
"typeParams": []
}
],
"properties": [
{
"name": "name",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 8,
"col": 4
},
"jsDoc": "`name` gives the plugin a name.",
"params": [],
"computed": false,
"optional": true,
"tsType": {
"repr": "string",
"kind": "keyword",
"keyword": "string"
},
"typeParams": []
},
{
"name": "test",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 10,
"col": 4
},
"jsDoc": "`test` matches the import url.",
"params": [],
"computed": false,
"optional": false,
"tsType": {
"repr": "RegExp",
"kind": "typeRef",
"typeRef": {
"typeParams": null,
"typeName": "RegExp"
}
},
"typeParams": []
},
{
"name": "acceptHMR",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 12,
"col": 4
},
"jsDoc": "`acceptHMR` accepts the HMR.",
"params": [],
"computed": false,
"optional": true,
"tsType": {
"repr": "boolean",
"kind": "keyword",
"keyword": "boolean"
},
"typeParams": []
}
],
"callSignatures": [],
"indexSignatures": [],
"typeParams": []
}
},
{
"kind": "interface",
"name": "SSROptions",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 22,
"col": 0
},
"jsDoc": "The options for **SSR**.",
"interfaceDef": {
"extends": [],
"methods": [],
"properties": [
{
"name": "fallback",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 24,
"col": 4
},
"jsDoc": "The fallback html **dynamic routes** (default is '**_fallback.html**').",
"params": [],
"computed": false,
"optional": true,
"tsType": {
"repr": "string",
"kind": "keyword",
"keyword": "string"
},
"typeParams": []
},
{
"name": "include",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 26,
"col": 4
},
"jsDoc": "A list of RegExp for paths to use **SSR**.",
"params": [],
"computed": false,
"optional": true,
"tsType": {
"repr": "",
"kind": "array",
"array": {
"repr": "RegExp",
"kind": "typeRef",
"typeRef": {
"typeParams": null,
"typeName": "RegExp"
}
}
},
"typeParams": []
},
{
"name": "exclude",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 28,
"col": 4
},
"jsDoc": "A list of RegExp for paths to skip **SSR**.",
"params": [],
"computed": false,
"optional": true,
"tsType": {
"repr": "",
"kind": "array",
"array": {
"repr": "RegExp",
"kind": "typeRef",
"typeRef": {
"typeParams": null,
"typeName": "RegExp"
}
}
},
"typeParams": []
},
{
"name": "staticPaths",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 30,
"col": 4
},
"jsDoc": "A list of paths for **dynamic routes** in **SSR**.",
"params": [],
"computed": false,
"optional": true,
"tsType": {
"repr": "",
"kind": "array",
"array": {
"repr": "string",
"kind": "keyword",
"keyword": "string"
}
},
"typeParams": []
}
],
"callSignatures": [],
"indexSignatures": [],
"typeParams": []
}
},
{
"kind": "interface",
"name": "Config",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 36,
"col": 0
},
"jsDoc": "Config for Aleph.js application.",
"interfaceDef": {
"extends": [],
"methods": [],
"properties": [
{
"name": "srcDir",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 38,
"col": 4
},
"jsDoc": "`srcDir` to put your application source code (default is '/').",
"params": [],
"computed": false,
"optional": true,
"tsType": {
"repr": "string",
"kind": "keyword",
"keyword": "string"
},
"typeParams": []
},
{
"name": "outputDir",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 40,
"col": 4
},
"jsDoc": "`outputDir` specifies the output directory for `build` command (default is '**dist**').",
"params": [],
"computed": false,
"optional": true,
"tsType": {
"repr": "string",
"kind": "keyword",
"keyword": "string"
},
"typeParams": []
},
{
"name": "baseUrl",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 42,
"col": 4
},
"jsDoc": "`baseUrl` specifies the path prefix for the application (default is '/').",
"params": [],
"computed": false,
"optional": true,
"tsType": {
"repr": "string",
"kind": "keyword",
"keyword": "string"
},
"typeParams": []
},
{
"name": "reactUrl",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 44,
"col": 4
},
"jsDoc": "`reactUrl` specifies the **react** download URL (default is 'https://esm.sh/react@17.0.1').",
"params": [],
"computed": false,
"optional": true,
"tsType": {
"repr": "string",
"kind": "keyword",
"keyword": "string"
},
"typeParams": []
},
{
"name": "reactDomUrl",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 46,
"col": 4
},
"jsDoc": "`reactDomUrl` specifies the **react-dom** download URL (default is 'https://esm.sh/react-dom@17.0.1').",
"params": [],
"computed": false,
"optional": true,
"tsType": {
"repr": "string",
"kind": "keyword",
"keyword": "string"
},
"typeParams": []
},
{
"name": "defaultLocale",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 48,
"col": 4
},
"jsDoc": "`defaultLocale` specifies the default locale of the application (default is '**en**').",
"params": [],
"computed": false,
"optional": true,
"tsType": {
"repr": "string",
"kind": "keyword",
"keyword": "string"
},
"typeParams": []
},
{
"name": "locales",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 50,
"col": 4
},
"jsDoc": "A list of locales.",
"params": [],
"computed": false,
"optional": true,
"tsType": {
"repr": "",
"kind": "array",
"array": {
"repr": "string",
"kind": "keyword",
"keyword": "string"
}
},
"typeParams": []
},
{
"name": "ssr",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 52,
"col": 4
},
"jsDoc": "The options for **SSR**.",
"params": [],
"computed": false,
"optional": true,
"tsType": {
"repr": "",
"kind": "union",
"union": [
{
"repr": "boolean",
"kind": "keyword",
"keyword": "boolean"
},
{
"repr": "SSROptions",
"kind": "typeRef",
"typeRef": {
"typeParams": null,
"typeName": "SSROptions"
}
}
]
},
"typeParams": []
},
{
"name": "plugins",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 54,
"col": 4
},
"jsDoc": "A list of plugin.",
"params": [],
"computed": false,
"optional": true,
"tsType": {
"repr": "",
"kind": "array",
"array": {
"repr": "Plugin",
"kind": "typeRef",
"typeRef": {
"typeParams": null,
"typeName": "Plugin"
}
}
},
"typeParams": []
},
{
"name": "postcss",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 56,
"col": 4
},
"jsDoc": "A list of plugin of PostCSS.",
"params": [],
"computed": false,
"optional": true,
"tsType": {
"repr": "",
"kind": "typeLiteral",
"typeLiteral": {
"methods": [],
"properties": [
{
"name": "plugins",
"params": [],
"computed": false,
"optional": false,
"tsType": {
"repr": "",
"kind": "array",
"array": {
"repr": "",
"kind": "parenthesized",
"parenthesized": {
"repr": "",
"kind": "union",
"union": [
{
"repr": "string",
"kind": "keyword",
"keyword": "string"
},
{
"repr": "",
"kind": "typeLiteral",
"typeLiteral": {
"methods": [],
"properties": [
{
"name": "name",
"params": [],
"computed": false,
"optional": false,
"tsType": {
"repr": "string",
"kind": "keyword",
"keyword": "string"
},
"typeParams": []
},
{
"name": "options",
"params": [],
"computed": false,
"optional": false,
"tsType": {
"repr": "Record",
"kind": "typeRef",
"typeRef": {
"typeParams": [
{
"repr": "string",
"kind": "keyword",
"keyword": "string"
},
{
"repr": "any",
"kind": "keyword",
"keyword": "any"
}
],
"typeName": "Record"
}
},
"typeParams": []
}
],
"callSignatures": [],
"indexSignatures": []
}
}
]
}
}
},
"typeParams": []
}
],
"callSignatures": [],
"indexSignatures": []
}
},
"typeParams": []
},
{
"name": "buildTarget",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 58,
"col": 4
},
"jsDoc": "`buildTarget` specifies the build target for **tsc** (possible values: '**ES2015**' - '**ES2020**' | '**ESNext**', default is **ES2015** for `production` and **ES2018** for `development`).",
"params": [],
"computed": false,
"optional": true,
"tsType": {
"repr": "string",
"kind": "keyword",
"keyword": "string"
},
"typeParams": []
},
{
"name": "sourceMap",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 60,
"col": 4
},
"jsDoc": "Enable sourceMap in **production** mode (default is **false**).",
"params": [],
"computed": false,
"optional": true,
"tsType": {
"repr": "boolean",
"kind": "keyword",
"keyword": "boolean"
},
"typeParams": []
},
{
"name": "env",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 62,
"col": 4
},
"jsDoc": "`env` appends env variables (use `Deno.env.get(key)` to get an env variable)",
"params": [],
"computed": false,
"optional": true,
"tsType": {
"repr": "Record",
"kind": "typeRef",
"typeRef": {
"typeParams": [
{
"repr": "string",
"kind": "keyword",
"keyword": "string"
},
{
"repr": "string",
"kind": "keyword",
"keyword": "string"
}
],
"typeName": "Record"
}
},
"typeParams": []
}
],
"callSignatures": [],
"indexSignatures": [],
"typeParams": []
}
},
{
"kind": "interface",
"name": "APIHandler",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 70,
"col": 0
},
"jsDoc": "A handler to handle api requests.\n\n@param req APIRequest object",
"interfaceDef": {
"extends": [],
"methods": [],
"properties": [],
"callSignatures": [
{
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 71,
"col": 4
},
"jsDoc": null,
"params": [
{
"kind": "identifier",
"name": "req",
"optional": false,
"tsType": {
"repr": "APIRequest",
"kind": "typeRef",
"typeRef": {
"typeParams": null,
"typeName": "APIRequest"
}
}
}
],
"tsType": {
"repr": "void",
"kind": "keyword",
"keyword": "void"
},
"typeParams": []
}
],
"indexSignatures": [],
"typeParams": []
}
},
{
"kind": "interface",
"name": "APIRequest",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 77,
"col": 0
},
"jsDoc": "The request object from api requests.",
"interfaceDef": {
"extends": [
{
"repr": "ServerRequest",
"kind": "typeRef",
"typeRef": {
"typeParams": null,
"typeName": "ServerRequest"
}
}
],
"methods": [
{
"name": "status",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 83,
"col": 4
},
"jsDoc": "`status` sets response status of the request.",
"optional": false,
"params": [
{
"kind": "identifier",
"name": "code",
"optional": false,
"tsType": {
"repr": "number",
"kind": "keyword",
"keyword": "number"
}
}
],
"returnType": {
"repr": "this",
"kind": "this",
"this": true
},
"typeParams": []
},
{
"name": "addHeader",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 86,
"col": 4
},
"jsDoc": "`addHeader` adds a new value onto an existing response header of the request, or\nadds the header if it does not already exist.",
"optional": false,
"params": [
{
"kind": "identifier",
"name": "key",
"optional": false,
"tsType": {
"repr": "string",
"kind": "keyword",
"keyword": "string"
}
},
{
"kind": "identifier",
"name": "value",
"optional": false,
"tsType": {
"repr": "string",
"kind": "keyword",
"keyword": "string"
}
}
],
"returnType": {
"repr": "this",
"kind": "this",
"this": true
},
"typeParams": []
},
{
"name": "setHeader",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 89,
"col": 4
},
"jsDoc": "`setHeader` sets a new value for an existing response header of the request, or adds\nthe header if it does not already exist.",
"optional": false,
"params": [
{
"kind": "identifier",
"name": "key",
"optional": false,
"tsType": {
"repr": "string",
"kind": "keyword",
"keyword": "string"
}
},
{
"kind": "identifier",
"name": "value",
"optional": false,
"tsType": {
"repr": "string",
"kind": "keyword",
"keyword": "string"
}
}
],
"returnType": {
"repr": "this",
"kind": "this",
"this": true
},
"typeParams": []
},
{
"name": "removeHeader",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 91,
"col": 4
},
"jsDoc": "`removeHeader` removes the value for an existing response header of the request.",
"optional": false,
"params": [
{
"kind": "identifier",
"name": "key",
"optional": false,
"tsType": {
"repr": "string",
"kind": "keyword",
"keyword": "string"
}
}
],
"returnType": {
"repr": "this",
"kind": "this",
"this": true
},
"typeParams": []
},
{
"name": "send",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 93,
"col": 4
},
"jsDoc": "`send` replies to the request with any content with type",
"optional": false,
"params": [
{
"kind": "identifier",
"name": "data",
"optional": false,
"tsType": {
"repr": "",
"kind": "union",
"union": [
{
"repr": "string",
"kind": "keyword",
"keyword": "string"
},
{
"repr": "Uint8Array",
"kind": "typeRef",
"typeRef": {
"typeParams": null,
"typeName": "Uint8Array"
}
},
{
"repr": "ArrayBuffer",
"kind": "typeRef",
"typeRef": {
"typeParams": null,
"typeName": "ArrayBuffer"
}
}
]
}
},
{
"kind": "identifier",
"name": "contentType",
"optional": true,
"tsType": {
"repr": "string",
"kind": "keyword",
"keyword": "string"
}
}
],
"returnType": {
"repr": "Promise",
"kind": "typeRef",
"typeRef": {
"typeParams": [
{
"repr": "void",
"kind": "keyword",
"keyword": "void"
}
],
"typeName": "Promise"
}
},
"typeParams": []
},
{
"name": "json",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 95,
"col": 4
},
"jsDoc": "`json` replies to the request with a json content",
"optional": false,
"params": [
{
"kind": "identifier",
"name": "data",
"optional": false,
"tsType": {
"repr": "any",
"kind": "keyword",
"keyword": "any"
}
}
],
"returnType": {
"repr": "Promise",
"kind": "typeRef",
"typeRef": {
"typeParams": [
{
"repr": "void",
"kind": "keyword",
"keyword": "void"
}
],
"typeName": "Promise"
}
},
"typeParams": []
},
{
"name": "decodeBody",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 97,
"col": 4
},
"jsDoc": "`decodeBody` will return a string, a form-data or any json object",
"optional": false,
"params": [
{
"kind": "identifier",
"name": "type",
"optional": false,
"tsType": {
"repr": "text",
"kind": "literal",
"literal": {
"kind": "string",
"string": "text"
}
}
}
],
"returnType": {
"repr": "Promise",
"kind": "typeRef",
"typeRef": {
"typeParams": [
{
"repr": "string",
"kind": "keyword",
"keyword": "string"
}
],
"typeName": "Promise"
}
},
"typeParams": []
},
{
"name": "decodeBody",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 98,
"col": 4
},
"jsDoc": null,
"optional": false,
"params": [
{
"kind": "identifier",
"name": "type",
"optional": false,
"tsType": {
"repr": "json",
"kind": "literal",
"literal": {
"kind": "string",
"string": "json"
}
}
}
],
"returnType": {
"repr": "Promise",
"kind": "typeRef",
"typeRef": {
"typeParams": [
{
"repr": "any",
"kind": "keyword",
"keyword": "any"
}
],
"typeName": "Promise"
}
},
"typeParams": []
},
{
"name": "decodeBody",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 99,
"col": 4
},
"jsDoc": null,
"optional": false,
"params": [
{
"kind": "identifier",
"name": "type",
"optional": false,
"tsType": {
"repr": "form-data",
"kind": "literal",
"literal": {
"kind": "string",
"string": "form-data"
}
}
}
],
"returnType": {
"repr": "Promise",
"kind": "typeRef",
"typeRef": {
"typeParams": [
{
"repr": "FormDataBody",
"kind": "typeRef",
"typeRef": {
"typeParams": null,
"typeName": "FormDataBody"
}
}
],
"typeName": "Promise"
}
},
"typeParams": []
}
],
"properties": [
{
"name": "pathname",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 78,
"col": 4
},
"jsDoc": null,
"params": [],
"computed": false,
"optional": false,
"tsType": {
"repr": "string",
"kind": "keyword",
"keyword": "string"
},
"typeParams": []
},
{
"name": "params",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 79,
"col": 4
},
"jsDoc": null,
"params": [],
"computed": false,
"optional": false,
"tsType": {
"repr": "Record",
"kind": "typeRef",
"typeRef": {
"typeParams": [
{
"repr": "string",
"kind": "keyword",
"keyword": "string"
},
{
"repr": "string",
"kind": "keyword",
"keyword": "string"
}
],
"typeName": "Record"
}
},
"typeParams": []
},
{
"name": "query",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 80,
"col": 4
},
"jsDoc": null,
"params": [],
"computed": false,
"optional": false,
"tsType": {
"repr": "URLSearchParams",
"kind": "typeRef",
"typeRef": {
"typeParams": null,
"typeName": "URLSearchParams"
}
},
"typeParams": []
},
{
"name": "cookies",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 81,
"col": 4
},
"jsDoc": null,
"params": [],
"computed": false,
"optional": false,
"tsType": {
"repr": "ReadonlyMap",
"kind": "typeRef",
"typeRef": {
"typeParams": [
{
"repr": "string",
"kind": "keyword",
"keyword": "string"
},
{
"repr": "string",
"kind": "keyword",
"keyword": "string"
}
],
"typeName": "ReadonlyMap"
}
},
"typeParams": []
}
],
"callSignatures": [],
"indexSignatures": [],
"typeParams": []
}
},
{
"kind": "interface",
"name": "RouterURL",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 105,
"col": 0
},
"jsDoc": "The Router object of the application routing, you can access it with `useRouter()`.",
"interfaceDef": {
"extends": [],
"methods": [],
"properties": [
{
"name": "locale",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 106,
"col": 4
},
"jsDoc": null,
"params": [],
"computed": false,
"optional": false,
"tsType": {
"repr": "string",
"kind": "keyword",
"keyword": "string"
},
"typeParams": []
},
{
"name": "pathname",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 107,
"col": 4
},
"jsDoc": null,
"params": [],
"computed": false,
"optional": false,
"tsType": {
"repr": "string",
"kind": "keyword",
"keyword": "string"
},
"typeParams": []
},
{
"name": "pagePath",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 108,
"col": 4
},
"jsDoc": null,
"params": [],
"computed": false,
"optional": false,
"tsType": {
"repr": "string",
"kind": "keyword",
"keyword": "string"
},
"typeParams": []
},
{
"name": "params",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 109,
"col": 4
},
"jsDoc": null,
"params": [],
"computed": false,
"optional": false,
"tsType": {
"repr": "Record",
"kind": "typeRef",
"typeRef": {
"typeParams": [
{
"repr": "string",
"kind": "keyword",
"keyword": "string"
},
{
"repr": "string",
"kind": "keyword",
"keyword": "string"
}
],
"typeName": "Record"
}
},
"typeParams": []
},
{
"name": "query",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 110,
"col": 4
},
"jsDoc": null,
"params": [],
"computed": false,
"optional": false,
"tsType": {
"repr": "URLSearchParams",
"kind": "typeRef",
"typeRef": {
"typeParams": null,
"typeName": "URLSearchParams"
}
},
"typeParams": []
}
],
"callSignatures": [],
"indexSignatures": [],
"typeParams": []
}
},
{
"kind": "interface",
"name": "FormDataBody",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 116,
"col": 0
},
"jsDoc": "The form data body",
"interfaceDef": {
"extends": [],
"methods": [
{
"name": "get",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 119,
"col": 4
},
"jsDoc": null,
"optional": false,
"params": [
{
"kind": "identifier",
"name": "key",
"optional": false,
"tsType": {
"repr": "string",
"kind": "keyword",
"keyword": "string"
}
}
],
"returnType": {
"repr": "",
"kind": "union",
"union": [
{
"repr": "string",
"kind": "keyword",
"keyword": "string"
},
{
"repr": "undefined",
"kind": "keyword",
"keyword": "undefined"
}
]
},
"typeParams": []
},
{
"name": "getFile",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 120,
"col": 4
},
"jsDoc": null,
"optional": false,
"params": [
{
"kind": "identifier",
"name": "key",
"optional": false,
"tsType": {
"repr": "string",
"kind": "keyword",
"keyword": "string"
}
}
],
"returnType": {
"repr": "",
"kind": "union",
"union": [
{
"repr": "FormFile",
"kind": "typeRef",
"typeRef": {
"typeParams": null,
"typeName": "FormFile"
}
},
{
"repr": "undefined",
"kind": "keyword",
"keyword": "undefined"
}
]
},
"typeParams": []
}
],
"properties": [
{
"name": "fields",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 117,
"col": 4
},
"jsDoc": null,
"params": [],
"computed": false,
"optional": false,
"tsType": {
"repr": "Record",
"kind": "typeRef",
"typeRef": {
"typeParams": [
{
"repr": "string",
"kind": "keyword",
"keyword": "string"
},
{
"repr": "string",
"kind": "keyword",
"keyword": "string"
}
],
"typeName": "Record"
}
},
"typeParams": []
},
{
"name": "files",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 118,
"col": 4
},
"jsDoc": null,
"params": [],
"computed": false,
"optional": false,
"tsType": {
"repr": "",
"kind": "array",
"array": {
"repr": "FormFile",
"kind": "typeRef",
"typeRef": {
"typeParams": null,
"typeName": "FormFile"
}
}
},
"typeParams": []
}
],
"callSignatures": [],
"indexSignatures": [],
"typeParams": []
}
},
{
"kind": "interface",
"name": "FormFile",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 126,
"col": 0
},
"jsDoc": "The form file data",
"interfaceDef": {
"extends": [],
"methods": [],
"properties": [
{
"name": "name",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 127,
"col": 4
},
"jsDoc": null,
"params": [],
"computed": false,
"optional": false,
"tsType": {
"repr": "string",
"kind": "keyword",
"keyword": "string"
},
"typeParams": []
},
{
"name": "content",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 128,
"col": 4
},
"jsDoc": null,
"params": [],
"computed": false,
"optional": false,
"tsType": {
"repr": "Uint8Array",
"kind": "typeRef",
"typeRef": {
"typeParams": null,
"typeName": "Uint8Array"
}
},
"typeParams": []
},
{
"name": "contentType",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 129,
"col": 4
},
"jsDoc": null,
"params": [],
"computed": false,
"optional": false,
"tsType": {
"repr": "string",
"kind": "keyword",
"keyword": "string"
},
"typeParams": []
},
{
"name": "filename",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 130,
"col": 4
},
"jsDoc": null,
"params": [],
"computed": false,
"optional": false,
"tsType": {
"repr": "string",
"kind": "keyword",
"keyword": "string"
},
"typeParams": []
},
{
"name": "size",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 131,
"col": 4
},
"jsDoc": null,
"params": [],
"computed": false,
"optional": false,
"tsType": {
"repr": "number",
"kind": "keyword",
"keyword": "number"
},
"typeParams": []
}
],
"callSignatures": [],
"indexSignatures": [],
"typeParams": []
}
},
{
"kind": "import",
"name": "ServerRequest",
"location": {
"filename": "https://deno.land/x/aleph@v0.2.28/types.ts",
"line": 1,
"col": 0
},
"jsDoc": null,
"importDef": {
"src": "https://deno.land/x/aleph@v0.2.28/std.ts",
"imported": "ServerRequest"
}
}
]