UNPKG

@loopback/docs

Version:
51 lines (31 loc) 1.54 kB
--- lang: en title: 'API docs: context.context.getsync' keywords: LoopBack 4.0, LoopBack 4 sidebar: lb4_sidebar permalink: /doc/en/lb4/apidocs.context.context.getsync.html --- <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@loopback/context](./context.md) &gt; [Context](./context.context.md) &gt; [getSync](./context.context.getsync.md) ## 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. <b>Signature:</b> ```typescript getSync<ValueType>(keyWithPath: BindingAddress<ValueType>, session?: ResolutionSession): ValueType; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | | keyWithPath | <code>BindingAddress&lt;ValueType&gt;</code> | The binding key, optionally suffixed with a path to the (deeply) nested property to retrieve. | | session | <code>ResolutionSession</code> | Session for resolution (accepted for backward compatibility) | <b>Returns:</b> `ValueType` A promise of the bound value. ## Example ```ts // 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'); ```