Preparing search index...
The search index is not available
@tarpit/http
@tarpit/http
PathArgs
Class PathArgs<T>
Type Parameters
T
extends
object
Hierarchy
Judgement
<
T
>
PathArgs
Index
Constructors
constructor
Properties
data
Methods
do_
if
ensure
get
get_
if
on_
error
Constructors
constructor
new
Path
Args
<
T
>
(
data
)
:
PathArgs
<
T
>
Type Parameters
T
extends
object
Parameters
data
:
undefined
|
T
Returns
PathArgs
<
T
>
Properties
data
data
:
undefined
|
T
Methods
do_
if
do_
if
<
M
,
P
>
(
prop
,
matcher
,
then
)
:
void
Type Parameters
M
extends
RegExp
|
Matcher
<
any
>
P
extends
string
Parameters
prop
:
P
matcher
:
M
then
:
(
(
res
)
=>
void
)
(
res
)
:
void
Parameters
res
:
PathValue
<
T
,
P
>
Returns
void
Returns
void
ensure
ensure
<
M
,
P
>
(
prop
,
matcher
,
on_error
?
)
:
Exclude
<
PathValue
<
T
,
P
>
,
undefined
>
Type Parameters
M
extends
RegExp
|
Matcher
<
any
>
P
extends
string
Parameters
prop
:
P
matcher
:
M
Optional
on_error
:
OnJudgementError
Returns
Exclude
<
PathValue
<
T
,
P
>
,
undefined
>
get
get
(
)
:
T
Returns
T
get
<
P
>
(
path
)
:
undefined
|
PathValue
<
T
,
P
>
Type Parameters
P
extends
string
Parameters
path
:
P
Returns
undefined
|
PathValue
<
T
,
P
>
get
<
P
>
(
path
,
def
)
:
Exclude
<
PathValue
<
T
,
P
>
,
undefined
>
Type Parameters
P
extends
string
Parameters
path
:
P
def
:
PathValue
<
T
,
P
>
Returns
Exclude
<
PathValue
<
T
,
P
>
,
undefined
>
get_
if
get_
if
<
M
,
P
>
(
prop
,
matcher
)
:
undefined
|
Exclude
<
PathValue
<
T
,
P
>
,
undefined
>
Type Parameters
M
extends
RegExp
|
Matcher
<
any
>
P
extends
string
Parameters
prop
:
P
matcher
:
M
Returns
undefined
|
Exclude
<
PathValue
<
T
,
P
>
,
undefined
>
get_
if
<
M
,
P
>
(
prop
,
matcher
,
def
)
:
Exclude
<
PathValue
<
T
,
P
>
,
undefined
>
Type Parameters
M
extends
RegExp
|
Matcher
<
any
>
P
extends
string
Parameters
prop
:
P
matcher
:
M
def
:
MatcherInferType
<
M
>
Returns
Exclude
<
PathValue
<
T
,
P
>
,
undefined
>
Protected
on_
error
on_
error
(
prop
,
desc
,
on_error
?
)
:
never
Parameters
prop
:
string
desc
:
MismatchDescription
Optional
on_error
:
(
(
prop
,
desc
)
=>
string
)
(
prop
,
desc
)
:
string
Parameters
prop
:
string
desc
:
MismatchDescription
Returns
string
Returns
never
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
src
errors
finish.ts
Finish
finish
tp-http-finish.ts
TpHttpFinish
TpHttpErrorDescription
TpHttpErrorHeader
throw_bad_request
throw_forbidden
throw_http_finish
throw_internal_server_error
throw_not_found
throw_not_modified
throw_precondition_failed
throw_unauthorized
builtin
body
form-body.ts
FormBody
json-body.ts
JsonBody
mime-body.ts
MimeBody
raw-body.ts
RawBody
text-body.ts
TextBody
dict
params.ts
Params
path-args.ts
PathArgs
header.ts
RequestHeaders
guard.ts
Guard
http-context.ts
HttpContext
response-cache.ts
ResponseCache
tp-request.ts
TpRequest
tp-response.ts
TpResponse
tp-websocket.ts
TpWebSocket
services
http-authenticator.ts
HttpAuthenticator
http-body-formatter.ts
HttpBodyFormatter
http-cache-proxy.ts
HttpCacheProxy
http-hooks.ts
HttpHooks
http-inspector.ts
HttpInspector
http-static.ts
HttpStatic
http-server.module.ts
HttpServerModule
__types__.ts
HttpCredentials
HttpHandlerDescriptor
HttpSession
TpRouterOptions
TpWebSocketOptions
ApiMethod
HttpResponseType
ProxyConfig
RequestHandler
RequestHandlerWithPathArgs
SocketHandler
TpHttpResponseType
UpgradeHandler
UpgradeHandlerWithPathArgs
annotations.ts
Auth
CacheUnder
ContentType
Delete
Get
Post
Put
Route
RouteProps
TpRouter
WS
Auth
CacheUnder
ContentType
Delete
Get
Post
Put
Route
TpRouter
WS
Generated using
TypeDoc