@loopback/docs
Version:
Documentation for LoopBack 4
49 lines (31 loc) • 1.37 kB
Markdown
lang: en
title: 'API docs: context.context.get_1'
keywords: LoopBack 4.0, LoopBack 4
sidebar: lb4_sidebar
permalink: /doc/en/lb4/apidocs.context.context.get_1.html
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@loopback/context](./context.md) > [Context](./context.context.md) > [get](./context.context.get_1.md)
## Context.get() method
Get the value bound to the given key, optionally return a (deep) property of the bound value.
<b>Signature:</b>
```typescript
get<ValueType>(keyWithPath: BindingAddress<ValueType>, options: ResolutionOptions): Promise<ValueType | undefined>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| keyWithPath | <code>BindingAddress<ValueType></code> | The binding key, optionally suffixed with a path to the (deeply) nested property to retrieve. |
| options | <code>ResolutionOptions</code> | Options for resolution. |
<b>Returns:</b>
`Promise<ValueType | undefined>`
A promise of the bound value, or a promise of undefined when the optional binding is not found.
## Example
```ts
// get "rest" property from the value bound to "config"
// use `undefined` when no config is provided
const config = await ctx.get<RestComponentConfig>('config#rest', {
optional: true
});
```