UNPKG

@loopback/docs

Version:
53 lines (33 loc) 1.56 kB
--- lang: en title: 'API docs: context.context.get' keywords: LoopBack 4.0, LoopBack 4 sidebar: lb4_sidebar permalink: /doc/en/lb4/apidocs.context.context.get.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; [get](./context.context.get.md) ## Context.get() method Get the value bound to the given key, throw an error when no value is bound for the given key. <b>Signature:</b> ```typescript get<ValueType>(keyWithPath: BindingAddress<ValueType>, session?: ResolutionSession): Promise<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> | Optional session for resolution (accepted for backward compatibility) | <b>Returns:</b> `Promise<ValueType>` A promise of the bound value. ## Example ```ts // get the value bound to "application.instance" const app = await ctx.get<Application>('application.instance'); // get "rest" property from the value bound to "config" const config = await ctx.get<RestComponentConfig>('config#rest'); // get "a" property of "numbers" property from the value bound to "data" ctx.bind('data').to({numbers: {a: 1, b: 2}, port: 3000}); const a = await ctx.get<number>('data#numbers.a'); ```