class Token
Language | Type name |
---|---|
![]() | Amazon.CDK.Token |
![]() | software.amazon.awscdk.core.Token |
![]() | aws_cdk.core.Token |
![]() | @aws-cdk/core » Token |
Represents a special or lazily-evaluated value.
Can be used to delay evaluation of a certain value in case, for example, that it requires some context or late-bound data. Can also be used to mark values that need special processing at document rendering time.
Tokens can be embedded into strings while retaining their original semantics.
Methods
Name | Description |
---|---|
static as | Return a resolvable representation of the given value. |
static as | Return a reversible list representation of this token. |
static as | Return a reversible number representation of this token. |
static as | Return a reversible string representation of this token. |
static compare | Compare two strings that might contain Tokens with each other. |
static is | Returns true if obj represents an unresolved value. |
Any(value)
static aspublic static asAny(value: any): IResolvable
Parameters
- value
any
Returns
Return a resolvable representation of the given value.
List(value, options?)
static aspublic static asList(value: any, options?: EncodingOptions): string[]
Parameters
- value
any
- options
Encoding
Options
Returns
string[]
Return a reversible list representation of this token.
Number(value)
static aspublic static asNumber(value: any): number
Parameters
- value
any
Returns
number
Return a reversible number representation of this token.
String(value, options?)
static aspublic static asString(value: any, options?: EncodingOptions): string
Parameters
- value
any
- options
Encoding
Options
Returns
string
Return a reversible string representation of this token.
If the Token is initialized with a literal, the stringified value of the literal is returned. Otherwise, a special quoted string representation of the Token is returned that can be embedded into other strings.
Strings with quoted Tokens in them can be restored back into
complex values with the Tokens restored by calling resolve()
on the string.
Strings(possibleToken1, possibleToken2)
static comparepublic static compareStrings(possibleToken1: string, possibleToken2: string): TokenComparison
Parameters
- possibleToken1
string
- possibleToken2
string
Returns
Compare two strings that might contain Tokens with each other.
Unresolved(obj)
static ispublic static isUnresolved(obj: any): boolean
Parameters
- obj
any
— The object to test.
Returns
boolean
Returns true if obj represents an unresolved value.
One of these must be true:
obj
is an IResolvableobj
is a string containing at least one encodedIResolvable
obj
is either an encoded number or list
This does NOT recurse into lists or objects to see if they containing resolvables.