Page Contents
Home > @loopback/context > BindingKey
BindingKey class
Signature:
export declare class BindingKey<ValueType>
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| [CONFIG\_NAMESPACE](/doc/en/lb4/apidocs.context.bindingkey.config_namespace.html) | `static` | string | Name space for configuration binding keys |
| [key](/doc/en/lb4/apidocs.context.bindingkey.key.html) | `readonly` | string | |
| [PROPERTY\_SEPARATOR](/doc/en/lb4/apidocs.context.bindingkey.property_separator.html) | `static` `readonly` | (not declared) | |
| [propertyPath?](/doc/en/lb4/apidocs.context.bindingkey.propertypath.html) | `readonly` | string \| undefined | _(Optional)_ |
Methods
| Method | Modifiers | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| [buildKeyForConfig(key)](/doc/en/lb4/apidocs.context.bindingkey.buildkeyforconfig.html) | `static` |
Build a binding key for the configuration of the given binding. The format is `|
[create(key, propertyPath)](/doc/en/lb4/apidocs.context.bindingkey.create.html)
|
`static`
|
Create a new key for a binding bound to a value of type `ValueType`.
|
[deepProperty(propertyPath)](/doc/en/lb4/apidocs.context.bindingkey.deepproperty.html)
|
|
Get a binding address for retrieving a deep property of the object bound to the current binding key.
|
[generate(namespace)](/doc/en/lb4/apidocs.context.bindingkey.generate.html)
|
`static`
|
Generate a universally unique binding key.
Please note the format of they generated key is not specified, you must not rely on any specific formatting (e.g. UUID style).
|
[parseKeyWithPath(keyWithPath)](/doc/en/lb4/apidocs.context.bindingkey.parsekeywithpath.html)
|
`static`
|
Parse a string containing both the binding key and the path to the deeply nested property to retrieve.
|
[toString()](/doc/en/lb4/apidocs.context.bindingkey.tostring.html)
|
|
|
[validate(key)](/doc/en/lb4/apidocs.context.bindingkey.validate.html)
|
`static`
|
Validate the binding key format. Please note that `#` is reserved. Returns a string representation of the binding key.
| |