@affordances/md/next
Type Aliases
Config
type Config = object;Properties
rewrites?
rewrites?: () => Promise<unknown> | unknown;Returns
Promise<unknown> | unknown
Has
type Has = object;Properties
key
key: string;type
type: "header" | "query";value?
value?: string;LlmsFullOptions
type LlmsFullOptions = Omit<MdHandlerOptions, "append"> & object;Type Declaration
| Name | Type |
|---|---|
pages? | Pages |
LlmsLink
type LlmsLink =
| string
| {
description?: string;
title: string;
url: string;
};LlmsTxtOptions
type LlmsTxtOptions = Omit<MdHandlerOptions, "append"> & object;Type Declaration
| Name | Type |
|---|---|
full? | string | false |
intro? | string |
sections()? | (request, routes) => object[] | Promise<object[]> |
summary? | string |
title? | string |
MdHandlerOptions
type MdHandlerOptions = object;Properties
append?
append?: (request) => Promise<string | undefined> | string | undefined;Parameters
| Parameter | Type |
|---|---|
request | Request |
Returns
Promise<string | undefined> | string | undefined
maxBytes?
maxBytes?: number;origin?
origin?: string;timeout?
timeout?: number;Pages
type Pages = (request, routes) => string[] | Promise<string[]>;Parameters
| Parameter | Type |
|---|---|
request | Request |
routes | string[] |
Returns
string[] | Promise<string[]>
Rewrite
type Rewrite = object;Properties
destination
destination: string;has?
has?: Has[];missing?
missing?: Has[];source
source: string;Rewrites
type Rewrites = object;Properties
afterFiles
afterFiles: Rewrite[];beforeFiles
beforeFiles: Rewrite[];fallback
fallback: Rewrite[];Variables
GET
const GET: (request) => Promise<Response>;Parameters
| Parameter | Type |
|---|---|
request | Request |
Returns
Promise<Response>
MD_PATH
const MD_PATH: "/api/affordances/md" = '/api/affordances/md';RENDER_HEADER
const RENDER_HEADER: "x-affordances-md-render" = 'x-affordances-md-render';rewrites
const rewrites: object;Type Declaration
| Name | Type |
|---|---|
afterFiles | object[] |
beforeFiles | object[] |
Functions
createLlmsFullHandler()
function createLlmsFullHandler(__namedParameters?): (request) => Promise<Response>;Parameters
| Parameter | Type |
|---|---|
__namedParameters? | LlmsFullOptions |
Returns
(request) => Promise<Response>
createLlmsTxtHandler()
function createLlmsTxtHandler(__namedParameters?): (request) => Promise<Response>;Parameters
| Parameter | Type |
|---|---|
__namedParameters? | LlmsTxtOptions |
Returns
(request) => Promise<Response>
createMdHandler()
function createMdHandler(__namedParameters?): (request) => Promise<Response>;Parameters
| Parameter | Type |
|---|---|
__namedParameters? | MdHandlerOptions |
Returns
(request) => Promise<Response>
md()
function md(): <C>(config) => C;Returns
<C>(config) => C
mdAlternate()
function mdAlternate(path): object;Parameters
| Parameter | Type |
|---|---|
path | string |
Returns
object
| Name | Type |
|---|---|
types | object |
types.text/markdown | string |
withMd()
function withMd<C>(config): C;Type Parameters
| Type Parameter |
|---|
C extends Config |
Parameters
| Parameter | Type |
|---|---|
config | C |
Returns
C