Page Contents
Home > @loopback/context > Context > getSync
Context.getSync() method
Get the synchronous value bound to the given key, optionally return a (deep) property of the bound value.
This method throws an error if the bound value requires async computation (returns a promise). You should never rely on sync bindings in production code.
Signature:
getSync<ValueType>(keyWithPath: BindingAddress<ValueType>, session?: ResolutionSession): ValueType;
Parameters
| Parameter | Type | Description |
|---|---|---|
| keyWithPath | BindingAddress<ValueType> | The binding key, optionally suffixed with a path to the (deeply) nested property to retrieve. |
| session | ResolutionSession | (Optional) Session for resolution (accepted for backward compatibility) |
Returns:
ValueType
A promise of the bound value.
Example
// get the value bound to "application.instance"
const app = ctx.getSync<Application>('application.instance');
// get "rest" property from the value bound to "config"
const config = await ctx.getSync<RestComponentConfig>('config#rest');