cdk-rest-api-with-spec.parameterkey.md

Home > @codemonger-io/cdk-rest-api-with-spec > ParameterKey

ParameterKey class

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Parsed request or response parameter key.

Signature:

export declare class ParameterKey 

Constructors

Constructor	Modifiers	Description
(constructor)(direction, name, location, explode)		(BETA) Constructs a new instance of the ParameterKey class

Properties

Property	Modifiers	Type	Description
direction	readonly	'request' | 'response'	(BETA) Request or response.
explode	readonly	boolean	(BETA) Whether the parameter can have multiple values.
location	readonly	'path' | 'query' | 'header'	(BETA) Location of the parameter.
name	readonly	string	(BETA) Name of the parameter.

Methods

Method	Modifiers	Description
parseParameterKey(key)	static	(BETA) Parses a given request or response parameter key.