Index
Modules:
auth/auth
,
core/application
,
core/beast/request
,
core/beast/server
,
core/configure
,
core/constants
,
core/context
,
core/defaultserversettings
,
core/encode
,
core/form
,
core/group
,
core/httpcore/httplogue
,
core/httpexception
,
core/middlewaresbase
,
core/nativesettings
,
core/pages
,
core/request
,
core/response
,
core/route
,
core/server
,
core/types
,
core/uid
,
core/urandom
,
core/utils
,
i18n/i18n
,
middlewares/auth
,
middlewares/clickjacking
,
middlewares/cors
,
middlewares/csrf
,
middlewares/sessions/memorysession
,
middlewares/sessions/redissession
,
middlewares/sessions/signedcookiesession
,
middlewares/utils
,
openapi/openapi
,
security/hasher
,
signing/signing
,
signing/signingbase
,
validate/basic
,
validate/validate
.
API symbols
`$`:
configure: `$`(env: Env): string
httplogue: `$`(headers: ResponseHeaders): string
response: `$`(response: Response): string
route: `$`(piece: BasePatternNode): string
route: `$`(node: PatternNode): string
types: `$`(secretKey: SecretKey): string
types: `$`(session: Session): string
`[]=`:
httplogue: `[]=`(headers: ResponseHeaders; key: string; value: seq[string])
httplogue: `[]=`(headers: ResponseHeaders; key, value: string)
types: `[]=`(formPart: FormPart; key: string; body: string)
types: `[]=`(session: var Session; key, value: string)
`[]`:
configure: `[]`(env: Env; key: string): string
httplogue: `[]`(headers: ResponseHeaders; key: string): seq[string]
httplogue: `[]`(headers: ResponseHeaders; key: string; i: int): string
nativesettings: `[]`(settings: Settings; key: string): JsonNode
types: `[]`(formPart: FormPart; key: string): tuple[params: StringTableRef, body: string]
types: `[]`(session: var Session; key: string): string
abort:
response: abort(code = Http401; body = ""; headers = initResponseHeaders(); version = HttpVer11): Response
AbortError:
httpexception: AbortError
abortExit:
context: abortExit(ctx: Context; code = Http401; body = ""; headers = initResponseHeaders(); version = HttpVer11)
accepted:
validate: accepted(msg = ""): ValidateHandler
add:
httplogue: add(headers: ResponseHeaders; key, value: string)
route: add(reRouter: var ReRouter; pairs: (RePath, PathHandler))
addGroup:
application: addGroup(group: Group; route: string; handler: HandlerAsync; httpMethod: openArray[HttpMethod]; name = ""; middlewares: openArray[HandlerAsync] = @[])
application: addGroup(group: Group; route: string; handler: HandlerAsync; httpMethod = HttpGet; name = ""; middlewares: openArray[HandlerAsync] = @[])
application: addGroup(app: Prologue; patterns: openArray[(Group, seq[UrlPattern])])
addHeader:
request: addHeader(request: var Request; key, value: string)
response: addHeader(response: var Response; key, value: string)
additionalSettings:
defaultserversettings: additionalSettings
addMiddlewares:
context: addMiddlewares(ctx: Context; middleware: HandlerAsync)
context: addMiddlewares(ctx: Context; middleware: seq[HandlerAsync])
addRoute:
application: addRoute(app: Prologue; patterns: openArray[UrlPattern]; baseRoute = ""; middlewares: Option[seq[HandlerAsync]] = none(seq[HandlerAsync]))
application: addRoute(app: Prologue; route: Regex; handler: HandlerAsync; httpMethod = HttpGet; middlewares: openArray[HandlerAsync] = @[])
application: addRoute(app: Prologue; route: Regex; handler: HandlerAsync; httpMethod: openArray[HttpMethod]; middlewares: openArray[HandlerAsync] = @[])
application: addRoute(app: Prologue; route: string; handler: HandlerAsync; httpMethod: openArray[HttpMethod]; name = ""; middlewares: openArray[HandlerAsync] = @[])
application: addRoute(app: Prologue; route: string; handler: HandlerAsync; httpMethod = HttpGet; name = ""; middlewares: openArray[HandlerAsync] = @[])
route: addRoute(router: Router; route: string; httpMethod: HttpMethod; handler: HandlerAsync; middlewares: seq[HandlerAsync])
all:
application: all(group: Group; route: string; handler: HandlerAsync; name = ""; middlewares: openArray[HandlerAsync] = @[])
application: all(app: Prologue; route: string; handler: HandlerAsync; name = ""; middlewares: openArray[HandlerAsync] = @[])
appAddress:
server: appAddress(app: Prologue): string
appDebug:
server: appDebug(app: Prologue): bool
appName:
server: appName(app: Prologue): string
appPort:
server: appPort(app: Prologue): Port
AsyncEvent:
context: AsyncEvent
attachment:
context: attachment(ctx: Context; downloadName: string; charset = "utf-8")
AuthMethod:
auth: AuthMethod
BadDataError:
signingbase: BadDataError
BadSecretKeyError:
types: BadSecretKeyError
BadSignatureError:
signingbase: BadSignatureError
BadTimeSignatureError:
signingbase: BadTimeSignatureError
base64Decode:
encode: base64Decode(s: string): string
base64Encode:
encode: base64Encode[T: SomeInteger | char](s: openArray[T]): string
encode: base64Encode(s: string): string
BaseDigestMethodType:
signing: BaseDigestMethodType
BaseDigestType:
signing: BaseDigestType
BasePatternNode:
context: BasePatternNode
BaseType:
types: BaseType
Basic:
AuthMethod.Basic
basicAuth:
auth: basicAuth(ctx: Context; realm: string; verify: VerifyHandler; charset = "UTF-8"): tuple[ hasValue: bool, username, password: string]
basicAuthMiddleware:
auth: basicAuthMiddleware(realm: string; verifyHandler: VerifyHandler; charset = "UTF-8"): HandlerAsync
beforeAPI:
utils: beforeAPI(version, body: untyped)
Blake2_224Type:
BaseDigestMethodType.Blake2_224Type
Blake2_256Type:
BaseDigestMethodType.Blake2_256Type
Blake2_384Type:
BaseDigestMethodType.Blake2_384Type
Blake2_512Type:
BaseDigestMethodType.Blake2_512Type
body:
request: body(request: Request): string
charset:
request: charset(request: Request): string
checkToken:
csrf: checkToken(checked, secret: string): bool
clear:
httplogue: clear(headers: ResponseHeaders)
types: clear(session: var Session)
clickjackingMiddleWare:
clickjacking: clickjackingMiddleWare(): HandlerAsync
close:
request: close(request: Request)
compress:
route: compress(router: Router)
Concat:
KeyDerivation.Concat
connect:
application: connect(group: Group; route: string; handler: HandlerAsync; name = ""; middlewares: openArray[HandlerAsync] = @[])
application: connect(app: Prologue; route: string; handler: HandlerAsync; name = ""; middlewares: openArray[HandlerAsync] = @[])
contains:
configure: contains(env: Env; key: string): bool
contentType:
request: contentType(request: Request): string
Context:
context: Context
CorsMiddleware:
cors: CorsMiddleware(allowOrigins: seq[string] = @[]; allowOriginRegex: Regex = re""; allowMethods: seq[string] = @["get"]; allowHeaders: seq[string] = @[]; exposeHeaders: seq[string] = @[]; allowCredentials = false; maxAge = 7200; excludeEndPoint: seq[string] = @[]): HandlerAsync
csrfMiddleWare:
csrf: csrfMiddleWare(tokenName = DefaultTokenName): HandlerAsync
csrfToken:
csrf: csrfToken(ctx: Context; tokenName = DefaultTokenName): string
CtxSettings:
nativesettings: CtxSettings
debugRequestMiddleware:
utils: debugRequestMiddleware(appName = "Prologue"): HandlerAsync
debugResponseMiddleware:
utils: debugResponseMiddleware(appName = "Prologue"): HandlerAsync
default404Handler:
context: default404Handler(ctx: Context): Future[void]
default500Handler:
context: default500Handler(ctx: Context): Future[void]
DefaultDigestMethodType:
signing: DefaultDigestMethodType
DefaultEntropy:
urandom: DefaultEntropy
defaultHandler:
context: defaultHandler(ctx: Context): Future[void]
DefaultKeyDerivation:
signing: DefaultKeyDerivation
DefaultSecretSize:
csrf: DefaultSecretSize
DefaultSep:
signing: DefaultSep
DefaultTokenName:
csrf: DefaultTokenName
DefaultTokenSize:
csrf: DefaultTokenSize
del:
httplogue: del(headers: ResponseHeaders; key: string)
types: del(session: var Session; key: string)
delete:
application: delete(group: Group; route: string; handler: HandlerAsync; name = ""; middlewares: openArray[HandlerAsync] = @[])
application: delete(app: Prologue; route: string; handler: HandlerAsync; name = ""; middlewares: openArray[HandlerAsync] = @[])
deleteCookie:
context: deleteCookie(ctx: Context; key: string; path = ""; domain = "")
response: deleteCookie(response: var Response; key: string; value = ""; path = ""; domain = "")
delPrologueEnv:
configure: delPrologueEnv(key: string; prefix: string)
Digest:
AuthMethod.Digest
doNothingClosureMiddleware:
middlewaresbase: doNothingClosureMiddleware(): HandlerAsync
dumps:
types: dumps(session: Session): string
DuplicatedReversedRouteError:
httpexception: DuplicatedReversedRouteError
DuplicatedRouteError:
httpexception: DuplicatedRouteError
EmptySecretKeyError:
types: EmptySecretKeyError
Env:
configure: Env
EnvError:
configure: EnvError
EnvWrongFormatError:
configure: EnvWrongFormatError
equals:
validate: equals(value: string; msg = ""): ValidateHandler
Error:
FlashLevel.Error
error404:
response: error404(code = Http404; body = "<h1>404 Not Found!</h1>"; headers = initResponseHeaders(); version = HttpVer11): Response
ErrorHandler:
context: ErrorHandler
ErrorHandlerTable:
context: ErrorHandlerTable
errorPage:
pages: errorPage(errorMsg: string): string
escape:
utils: escape(src: string): string
Event:
context: Event
execEvent:
context: execEvent(event: Event)
execStartupEvent:
server: execStartupEvent(app: Prologue)
existsPrologueEnv:
configure: existsPrologueEnv(key: string; prefix: string): bool
Fault:
FlashLevel.Fault
findHandler:
route: findHandler(ctx: Context): PathHandler
route: findHandler(ctx: Context; reqMethod: HttpMethod; path: string): Option[ PathHandler]
first:
context: first(ctx: Context): bool
first=:
context: first=(ctx: Context; first: bool)
flash:
context: flash(ctx: Context; msgs: string; category = FlashLevel.Info)
context: flash(ctx: Context; msgs: string; category: string)
types: flash(session: var Session; msgs: string; category = FlashLevel.Info)
types: flash(session: var Session; msgs: string; category: string)
FlashLevel:
types: FlashLevel
FormPart:
types: FormPart
FormValidation:
validate: FormValidation
fromByteSeq:
utils: fromByteSeq(sequence: openArray[byte]): string
generateToken:
csrf: generateToken(ctx: Context; tokenName = DefaultTokenName): string
genUid:
uid: genUid(): string
get:
application: get(group: Group; route: string; handler: HandlerAsync; name = ""; middlewares: openArray[HandlerAsync] = @[])
application: get(app: Prologue; route: string; handler: HandlerAsync; name = ""; middlewares: openArray[HandlerAsync] = @[])
configure: get(env: Env; key: string): string
getAllInfos:
group: getAllInfos(group: Group; route: string; middlewares: openArray[HandlerAsync]): ( string, seq[HandlerAsync])
getAllPrologueEnv:
configure: getAllPrologueEnv(prefix: string): OrderedTableRef[string, string]
getCookie:
request: getCookie(request: Request; key: string; default: string): string
context: getCookie(ctx: Context; key: string; default = ""): string
getFlashedMsg:
context: getFlashedMsg(ctx: Context; category: FlashLevel): Option[string]
context: getFlashedMsg(ctx: Context; category: string): Option[string]
getFlashedMsgs:
context: getFlashedMsgs(ctx: Context): seq[string]
getFlashedMsgsWithCategory:
context: getFlashedMsgsWithCategory(ctx: Context): seq[(string, string)]
getFormParams:
context: getFormParams(ctx: Context; key: string; default = ""): string
getHeader:
request: getHeader(request: Request; key: string): seq[string]
response: getHeader(response: Response; key: string): seq[string]
getHeaderOrDefault:
request: getHeaderOrDefault(request: Request; key: string; default = @[""]): seq[string]
response: getHeaderOrDefault(response: Response; key: string; default = @[""]): seq[string]
getMessage:
types: getMessage(session: var Session; category: FlashLevel): Option[string]
types: getMessage(session: var Session; category: string): Option[string]
getOrDefault:
configure: getOrDefault[T: BaseType](env: Env; key: string; default: T): T
httplogue: getOrDefault(headers: ResponseHeaders; key: string; default = @[""]): seq[string]
nativesettings: getOrDefault(settings: Settings; key: string): JsonNode
types: getOrDefault(session: var Session; key: string; default = ""): string
getPathParams:
context: getPathParams(ctx: Context; key: string): string
context: getPathParams[T: BaseType](ctx: Context; key: string; default: T): T
getPostParams:
context: getPostParams(ctx: Context; key: string; default = ""): string
getPrologueEnv:
configure: getPrologueEnv(): string
configure: getPrologueEnv(key: string; prefix: string; default = ""): string
getQueryParams:
context: getQueryParams(ctx: Context; key: string; default = ""): string
getServerSettingsName:
defaultserversettings: getServerSettingsName(key: string): string
getServerSettingsNameOrKey:
defaultserversettings: getServerSettingsNameOrKey(key: string): string
getSettings:
context: getSettings(ctx: Context; key: string): JsonNode
getSignatureDecode:
signing: getSignatureDecode(s: Signer | TimedSigner): string
getSignatureEncode:
signing: getSignatureEncode(s: Signer | TimedSigner; value: openArray[byte]): string
getTables:
httplogue: getTables(headers: ResponseHeaders): TableRef[string, seq[string]]
getToken:
csrf: getToken(ctx: Context; tokenName = DefaultTokenName): string
getUploadFile:
context: getUploadFile(ctx: Context; name: string): UploadFile
GlobalScope:
context: GlobalScope
Group:
group: Group
gScope:
context: gScope(ctx: Context): lent GlobalScope
handleContext:
application: handleContext(app: Prologue; ctx: Context): owned(Future[void])
HandlerAsync:
context: HandlerAsync
handleRequest:
application: handleRequest(app: Prologue; nativeRequest: NativeRequest): Future[void]
hash:
route: hash(x: Path): Hash
hasHeader:
request: hasHeader(request: Request; key: string): bool
response: hasHeader(response: Response; key: string): bool
hasKey:
configure: hasKey(env: Env; key: string): bool
httplogue: hasKey(headers: ResponseHeaders; key: string): bool
nativesettings: hasKey(settings: Settings; key: string): bool
head:
application: head(group: Group; route: string; handler: HandlerAsync; name = ""; middlewares: openArray[HandlerAsync] = @[])
application: head(app: Prologue; route: string; handler: HandlerAsync; name = ""; middlewares: openArray[HandlerAsync] = @[])
headers:
request: headers(request: Request): HttpHeaders
hostName:
request: hostName(request: Request): string
htmlResponse:
response: htmlResponse(text: string; code = Http200; headers = initResponseHeaders(); version = HttpVer11): Response
HttpError:
httpexception: HttpError
httpRedirectMiddleWare:
utils: httpRedirectMiddleWare(): HandlerAsync
incSize:
context: incSize(ctx: Context; num = 1)
Info:
FlashLevel.Info
validate: Info
initEnv:
configure: initEnv(): Env
initEvent:
context: initEvent(handler: AsyncEvent): Event
context: initEvent(handler: SyncEvent): Event
initFormPart:
types: initFormPart(): FormPart
initMockingRequest:
request: initMockingRequest(httpMethod: HttpMethod; headers: HttpHeaders; url: Uri; cookies = initCookieJar(); postParams = newStringTable(); queryParams = newStringTable(); formParams = initFormPart(); pathParams = newStringTable()): Request
initPath:
route: initPath(route: string; httpMethod = HttpGet): Path
initRePath:
route: initRePath(route: Regex; httpMethod = HttpGet): RePath
initRequest:
request: initRequest(nativeRequest: NativeRequest; cookies = initCookieJar(); pathParams = newStringTable(modeCaseSensitive); queryParams = newStringTable(modeCaseSensitive); postParams = newStringTable(modeCaseSensitive)): Request
initResponse:
response: initResponse(httpVersion: HttpVersion; code: HttpCode; headers: openArray[(string, string)]; body = ""): Response
response: initResponse(httpVersion: HttpVersion; code: HttpCode; headers = [ ("Content-Type", "text/html; charset=UTF-8")].initResponseHeaders; body = ""): Response
initResponseHeaders:
httplogue: initResponseHeaders(): ResponseHeaders
httplogue: initResponseHeaders(keyValuePairs: openArray[tuple[key: string, val: string]]): ResponseHeaders
initSigner:
signing: initSigner(secretKey: SecretKey; salt = DefaultSalt; sep = DefaultSep; keyDerivation = DefaultKeyDerivation; digestMethod = DefaultDigestMethodType): Signer
initTimedSigner:
signing: initTimedSigner(secretKey: SecretKey; salt = DefaultSalt; sep = DefaultSep; keyDerivation = DefaultKeyDerivation; digestMethod = DefaultDigestMethodType): TimedSigner
initUploadFile:
context: initUploadFile(filename, body: string): UploadFile
internalServerErrorPage:
pages: internalServerErrorPage(): string
isBool:
basic: isBool(value: string): bool
validate: isBool(msg = ""): ValidateHandler
isInt:
basic: isInt(value: string): bool
validate: isInt(msg = ""): ValidateHandler
isNumeric:
basic: isNumeric(value: string): bool
validate: isNumeric(msg = ""): ValidateHandler
items:
route: items(reRouter: ReRouter): (RePath, PathHandler)
jsonResponse:
response: jsonResponse(text: JsonNode; code = Http200; headers = initResponseHeaders(); version = HttpVer11): Response
Keccak224Type:
BaseDigestMethodType.Keccak224Type
Keccak256Type:
BaseDigestMethodType.Keccak256Type
Keccak384Type:
BaseDigestMethodType.Keccak384Type
Keccak512Type:
BaseDigestMethodType.Keccak512Type
KeyDerivation:
signing: KeyDerivation
KeyHmac:
KeyDerivation.KeyHmac
keys:
configure: keys(env: Env): string
len:
httplogue: len(headers: ResponseHeaders): int
types: len(secretKey: SecretKey): int
types: len(session: Session): int
loadPrologueEnv:
configure: loadPrologueEnv(filename: string): Env
loads:
types: loads(session: var Session; s: string)
loadSettings:
nativesettings: loadSettings(data: JsonNode): Settings
nativesettings: loadSettings(configPath: string): Settings
loadTranslate:
i18n: loadTranslate(app: Prologue; filename: string)
i18n: loadTranslate(stream: Stream; filename = "[stream]"): TableRef[string, StringTableRef]
i18n: loadTranslate(filename: string): TableRef[string, StringTableRef]
loggingMiddleware:
utils: loggingMiddleware(appName = "Prologue"): HandlerAsync
loginPage:
pages: loginPage(): string
matchRegex:
validate: matchRegex(value: Regex; msg = ""): ValidateHandler
matchURL:
validate: matchURL(msg = ""): ValidateHandler
maxLength:
validate: maxLength(max: Natural; msg = ""): ValidateHandler
maxValue:
validate: maxValue(max: float; msg = ""): ValidateHandler
messages:
types: messages(session: var Session): seq[string]
messagesWithCategory:
types: messagesWithCategory(session: var Session): seq[(string, string)]
middlewares:
context: middlewares(ctx: Context): lent seq[HandlerAsync]
middlewares=:
context: middlewares=(ctx: Context; middlewares: seq[HandlerAsync])
minLength:
validate: minLength(min: Natural; msg = ""): ValidateHandler
minValue:
validate: minValue(min: float; msg = ""): ValidateHandler
MoreConcat:
KeyDerivation.MoreConcat
multiPartPage:
pages: multiPartPage(): string
NativeRequest:
request: NativeRequest
newApp:
application: newApp(settings: Settings = newSettings(); middlewares: openArray[HandlerAsync] = @[]; startup: openArray[Event] = @[]; shutdown: openArray[Event] = @[]; errorHandlerTable = newErrorHandlerTable( [(Http404, default404Handler), (Http500, default500Handler)]); appData = newStringTable(mode = modeCaseSensitive)): Prologue
newAppQueryEnv:
application: newAppQueryEnv(middlewares: openArray[HandlerAsync] = @[]; startup: openArray[Event] = @[]; shutdown: openArray[Event] = @[]; errorHandlerTable = newErrorHandlerTable( [(Http404, default404Handler), (Http500, default500Handler)]); appData = newStringTable(mode = modeCaseSensitive)): Prologue
newContext:
context: newContext(ctx: Context; src: Context)
context: newContext(request: Request; response: Response; gScope: GlobalScope): Context
newContextFrom:
context: newContextFrom(ctx: Context; src: Context)
newContextTo:
context: newContextTo(ctx: Context; src: Context)
newCtxSettings:
nativesettings: newCtxSettings(): CtxSettings
newErrorHandlerTable:
context: newErrorHandlerTable(initialSize = defaultInitialSize): ErrorHandlerTable
context: newErrorHandlerTable(pairs: openArray[(HttpCode, ErrorHandler)]): ErrorHandlerTable
newFormValidation:
validate: newFormValidation(validator: openArray[(string, seq[ValidateHandler])]): FormValidation
newGroup:
group: newGroup(app: Prologue; route: string; middlewares: openArray[HandlerAsync] = @[]; parent: Group = nil): Group
newPathHandler:
route: newPathHandler(handler: HandlerAsync; middlewares: seq[HandlerAsync]): PathHandler
newPrologue:
server: newPrologue(settings: Settings; ctxSettings: CtxSettings; router: Router; reversedRouter: ReversedRouter; reRouter: ReRouter; middlewares: openArray[HandlerAsync]; startup: openArray[Event]; shutdown: openArray[Event]; errorHandlerTable: ErrorHandlerTable; appData: StringTableRef): Prologue
newReRouter:
route: newReRouter(): ReRouter
newReversedRouter:
context: newReversedRouter(): ReversedRouter
newRouter:
route: newRouter(): Router
newSession:
types: newSession(data: StringTableRef; newCreated = false; modified = false; accessed = false): Session
newSettings:
nativesettings: newSettings(address = ""; port = Port(8080); debug = true; reusePort = true; secretKey = randomString(8); appName = ""; bufSize = 40960): Settings
None:
KeyDerivation.None
openapiHandler:
openapi: openapiHandler(ctx: Context): owned(Future[void])
options:
application: options(group: Group; route: string; handler: HandlerAsync; name = ""; middlewares: openArray[HandlerAsync] = @[])
application: options(app: Prologue; route: string; handler: HandlerAsync; name = ""; middlewares: openArray[HandlerAsync] = @[])
pairs:
configure: pairs(env: Env): (string, string)
httplogue: pairs(headers: ResponseHeaders): tuple[key, value: string]
types: pairs(session: Session): tuple[key, val: string]
parseFormParams:
form: parseFormParams(request: var Request; contentType: string)
parseFormPart:
form: parseFormPart(body, contentType: string): FormPart
parseStringTable:
types: parseStringTable(tabs: var StringTableRef; s: string)
parseValue:
types: parseValue[T: BaseType](value: string; default: T): T
patch:
application: patch(group: Group; route: string; handler: HandlerAsync; name = ""; middlewares: openArray[HandlerAsync] = @[])
application: patch(app: Prologue; route: string; handler: HandlerAsync; name = ""; middlewares: openArray[HandlerAsync] = @[])
path:
request: path(request: Request): string
Path:
context: Path
PathHandler:
context: PathHandler
pattern:
route: pattern(route: string; handler: HandlerAsync; httpMethod: openArray[HttpMethod]; name = ""; middlewares: openArray[HandlerAsync] = @[]): UrlPattern
route: pattern(route: string; handler: HandlerAsync; httpMethod = HttpGet; name = ""; middlewares: openArray[HandlerAsync] = @[]): UrlPattern
PatternMatchingType:
context: PatternMatchingType
PatternNode:
context: PatternNode
pbkdf2_sha1encode:
hasher: pbkdf2_sha1encode(password: SecretKey; salt: string; iterations = 24400): string
pbkdf2_sha1verify:
hasher: pbkdf2_sha1verify(password: SecretKey; encoded: string): bool
pbkdf2_sha256encode:
hasher: pbkdf2_sha256encode(password: SecretKey; salt: string; iterations = 24400): string
pbkdf2_sha256verify:
hasher: pbkdf2_sha256verify(password: SecretKey; encoded: string): bool
plainTextResponse:
response: plainTextResponse(text: string; code = Http200; headers = initResponseHeaders(); version = HttpVer11): Response
port:
request: port(request: Request): string
post:
application: post(group: Group; route: string; handler: HandlerAsync; name = ""; middlewares: openArray[HandlerAsync] = @[])
application: post(app: Prologue; route: string; handler: HandlerAsync; name = ""; middlewares: openArray[HandlerAsync] = @[])
printRoutingTree:
route: printRoutingTree(router: Router)
Prologue:
server: Prologue
PrologueError:
httpexception: PrologueError
ProloguePrefix:
constants: ProloguePrefix
PrologueVersion:
constants: PrologueVersion
ptrnParam:
PatternMatchingType.ptrnParam
ptrnText:
PatternMatchingType.ptrnText
ptrnWildcard:
PatternMatchingType.ptrnWildcard
put:
application: put(group: Group; route: string; handler: HandlerAsync; name = ""; middlewares: openArray[HandlerAsync] = @[])
application: put(app: Prologue; route: string; handler: HandlerAsync; name = ""; middlewares: openArray[HandlerAsync] = @[])
putPrologueEnv:
configure: putPrologueEnv(key, val: string; prefix: string)
query:
request: query(request: Request): string
randomBytesSeq:
urandom: randomBytesSeq(size = DefaultEntropy): seq[byte]
urandom: randomBytesSeq[size = DefaultEntropy](): array[size, byte]
randomSecretKey:
urandom: randomSecretKey(size = DefaultEntropy): SecretKey
randomString:
urandom: randomString(size = DefaultEntropy): string
rangeLength:
validate: rangeLength(min, max: Natural; msg = ""): ValidateHandler
rangeValue:
validate: rangeValue(min, max: float; msg = ""): ValidateHandler
redirect:
response: redirect(url: string; code = Http301; body = ""; delay = 0; headers = initResponseHeaders(); version = HttpVer11): Response
redocs:
openapi: redocs
redocsHandler:
openapi: redocsHandler(ctx: Context): owned(Future[void])
registerErrorHandler:
application: registerErrorHandler(app: Prologue; code: HttpCode; handler: ErrorHandler)
application: registerErrorHandler(app: Prologue; code: openArray[HttpCode]; handler: ErrorHandler)
application: registerErrorHandler(app: Prologue; code: set[HttpCode]; handler: ErrorHandler)
RePath:
context: RePath
reqMethod:
request: reqMethod(request: Request): HttpMethod
Request:
request: Request
required:
validate: required(msg = ""): ValidateHandler
ReRouter:
context: ReRouter
resp:
response: resp(response: Response)
response: resp(body: string; code = Http200; version = HttpVer11)
respDefault:
response: respDefault(code: HttpCode)
respond:
request: respond(request: Request; code: HttpCode; body: string): Future[void]
request: respond(request: Request; code: HttpCode; body: string; headers: ResponseHeaders): Future[ void]
request: respond(request: Request; response: Response): Future[void]
context: respond(ctx: Context): Future[void]
context: respond(ctx: Context; code: HttpCode; body: string): Future[void]
context: respond(ctx: Context; code: HttpCode; body: string; headers: ResponseHeaders): Future[ void]
Response:
response: Response
ResponseHeaders:
httplogue: ResponseHeaders
ReversedRouter:
context: ReversedRouter
Ripemd128Type:
BaseDigestMethodType.Ripemd128Type
Ripemd160Type:
BaseDigestMethodType.Ripemd160Type
Ripemd256Type:
BaseDigestMethodType.Ripemd256Type
Ripemd320Type:
BaseDigestMethodType.Ripemd320Type
RouteError:
httpexception: RouteError
Router:
context: Router
RouteResetError:
httpexception: RouteResetError
run:
application: run(app: Prologue)
save:
context: save(uploadFile: UploadFile; dir: string; filename = "")
scheme:
request: scheme(request: Request): string
SecretKey:
types: SecretKey
SecretUrl:
types: SecretUrl
secure:
request: secure(request: Request): bool
send:
request: send(request: Request; content: string): Future[void]
context: send(ctx: Context; content: string): Future[void]
serialize:
utils: serialize(number: int16): array[2, byte]
utils: serialize(number: int32): array[4, byte]
utils: serialize(number: int64): array[8, byte]
serve:
server: serve(app: Prologue; callback: proc (request: NativeRequest): Future[void] {.closure, gcsafe.})
serveDocs:
openapi: serveDocs(app: Prologue; source: string; onlyDebug = false)
Session:
types: Session
sessionMiddleware:
memorysession: sessionMiddleware(settings: Settings; sessionName = "session"; maxAge: int = 20160 * 60; path = ""; domain = ""; sameSite = Lax; httpOnly = false): HandlerAsync
redissession: sessionMiddleware(settings: Settings; sessionName = "session"; maxAge: int = 20160 * 60; path = ""; domain = ""; sameSite = Lax; httpOnly = false): HandlerAsync
signedcookiesession: sessionMiddleware(settings: Settings; sessionName = "session"; maxAge: int = 20160 * 60; path = ""; domain = ""; sameSite = Lax; httpOnly = false): HandlerAsync
setCookie:
context: setCookie(ctx: Context; key, value: string; expires: DateTime | Time; maxAge: Option[int] = none(int); domain = ""; path = ""; secure = false; httpOnly = false; sameSite = Lax)
context: setCookie(ctx: Context; key, value: string; expires = ""; maxAge: Option[int] = none(int); domain = ""; path = ""; secure = false; httpOnly = false; sameSite = Lax)
response: setCookie(response: var Response; key, value: string; expires: DateTime | Time; maxAge: Option[int] = none(int); domain = ""; path = ""; secure = false; httpOnly = false; sameSite = Lax)
response: setCookie(response: var Response; key, value: string; expires = ""; maxAge: Option[int] = none(int); domain = ""; path = ""; secure = false; httpOnly = false; sameSite = Lax)
setHeader:
request: setHeader(request: var Request; key: string; value: seq[string])
request: setHeader(request: var Request; key, value: string)
response: setHeader(response: var Response; key: string; value: seq[string])
response: setHeader(response: var Response; key, value: string)
setLanguage:
i18n: setLanguage(ctx: Context; language: string): Translator
setPrologueEnv:
configure: setPrologueEnv(env: Env; key, value: string)
setResponse:
context: setResponse(ctx: Context; code: HttpCode; body = ""; version = HttpVer11)
context: setResponse(ctx: Context; response: Response)
setScheme:
request: setScheme(request: var Request; value: string)
Settings:
nativesettings: Settings
setToken:
csrf: setToken(ctx: Context; value: string; tokenName = DefaultTokenName)
Sha1Type:
BaseDigestMethodType.Sha1Type
Sha224Type:
BaseDigestMethodType.Sha224Type
Sha3_224Type:
BaseDigestMethodType.Sha3_224Type
Sha3_256Type:
BaseDigestMethodType.Sha3_256Type
Sha3_384Type:
BaseDigestMethodType.Sha3_384Type
Sha3_512Type:
BaseDigestMethodType.Sha3_512Type
Sha384Type:
BaseDigestMethodType.Sha384Type
Sha512_224Type:
BaseDigestMethodType.Sha512_224Type
Sha512_256Type:
BaseDigestMethodType.Sha512_256Type
Sha512Type:
BaseDigestMethodType.Sha512Type
sign:
signing: sign(s: Signer; value: string): string
signing: sign(s: TimedSigner; value: string): string
SignatureExpiredError:
signingbase: SignatureExpiredError
Signer:
signing: Signer
since:
utils: since(version, body: untyped)
sinceAPI:
utils: sinceAPI(version, body: untyped)
size:
context: size(ctx: Context): int8
staticFileResponse:
context: staticFileResponse(ctx: Context; filename, dir: string; mimetype = ""; downloadName = ""; charset = "utf-8"; bufSize = 40960; headers = none(ResponseHeaders)): owned(Future[void])
stripPath:
request: stripPath(request: var Request)
stripPathMiddleware:
utils: stripPathMiddleware(appName = "Prologue"): HandlerAsync
stripRoute:
route: stripRoute(route: string): string
swaggerDocs:
openapi: swaggerDocs
swaggerHandler:
openapi: swaggerHandler(ctx: Context): owned(Future[void])
switch:
middlewaresbase: switch(ctx: Context): owned(Future[void])
SyncEvent:
context: SyncEvent
testMiddleware:
utils: testMiddleware(): HandlerAsync
TimedSigner:
signing: TimedSigner
toByteSeq:
utils: toByteSeq(str: string): seq[byte]
Tr:
i18n: Tr(ctx: Context; text: string; language: string): string
i18n: Tr(t: Translator; text: string): string
trace:
application: trace(group: Group; route: string; handler: HandlerAsync; name = ""; middlewares: openArray[HandlerAsync] = @[])
application: trace(app: Prologue; route: string; handler: HandlerAsync; name = ""; middlewares: openArray[HandlerAsync] = @[])
translate:
i18n: translate(ctx: Context; text: string; language: string): string
i18n: translate(t: Translator; text: string): string
Translator:
i18n: Translator
unauthenticate:
auth: unauthenticate(ctx: Context; authMethod: AuthMethod; realm: string; charset = "UTF-8")
unsign:
signing: unsign(s: Signer | TimedSigner; signedValue: string): string
signing: unsign(s: TimedSigner; signedValue: string; max_age: Natural): string
UploadFile:
context: UploadFile
url:
request: url(request: Request): Uri
urlFor:
context: urlFor(ctx: Context; handler: string; parameters: openArray[(string, string)] = @[]; queryParams: openArray[(string, string)] = @[]; usePlus = true; omitEq = true): string
UrlPattern:
route: UrlPattern
urlsafeBase64Decode:
encode: urlsafeBase64Decode(s: string): string
urlsafeBase64Encode:
encode: urlsafeBase64Encode[T: SomeInteger | char](s: openArray[T]): string
encode: urlsafeBase64Encode(s: string): string
use:
application: use(app: var Prologue; middlewares: varargs[HandlerAsync])
useAsyncHTTPServer:
constants: useAsyncHTTPServer
validate:
signing: validate(s: Signer; signedValue: string): bool
validate: validate(formValidation: FormValidation; textTable: StringTableRef; allMsgs = true): Info
ValidateHandler:
validate: ValidateHandler
values:
configure: values(env: Env): string
VerifyHandler:
auth: VerifyHandler
Warning:
FlashLevel.Warning
writePrologueEnv:
configure: writePrologueEnv(filename: string; env: Env)