@loopback/docs 6.0.5 → 7.0.0

package/site/apidocs/context.invocationargs.md

@@ -0,0 +1,23 @@
+---
+lang: en
+title: 'API docs: context.invocationargs'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/context
+permalink: /doc/en/lb4/apidocs.context.invocationargs.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/context](./context.md) &gt; [InvocationArgs](./context.invocationargs.md)
+
+## InvocationArgs type
+
+Array of arguments for a method invocation
+
+**Signature:**
+
+```typescript
+export type InvocationArgs = any[];
+```
+

package/site/apidocs/context.invocationcontext._constructor_.md

@@ -0,0 +1,34 @@
+---
+lang: en
+title: 'API docs: context.invocationcontext._constructor_'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/context
+permalink: /doc/en/lb4/apidocs.context.invocationcontext._constructor_.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/context](./context.md) &gt; [InvocationContext](./context.invocationcontext.md) &gt; [(constructor)](./context.invocationcontext._constructor_.md)
+
+## InvocationContext.(constructor)
+
+Construct a new instance of `InvocationContext`
+
+**Signature:**
+
+```typescript
+constructor(parent: Context, target: object, methodName: string, args: InvocationArgs, source?: InvocationSource<unknown> | undefined);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  parent | [Context](./context.context.md) | Parent context, such as the RequestContext |
+|  target | object | Target class (for static methods) or prototype/object (for instance methods) |
+|  methodName | string | Method name |
+|  args | [InvocationArgs](./context.invocationargs.md) | An array of arguments |
+|  source | [InvocationSource](./context.invocationsource.md)<!-- -->&lt;unknown&gt; \| undefined | _(Optional)_ |
+
+

package/site/apidocs/context.invocationcontext.args.md

@@ -0,0 +1,21 @@
+---
+lang: en
+title: 'API docs: context.invocationcontext.args'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/context
+permalink: /doc/en/lb4/apidocs.context.invocationcontext.args.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/context](./context.md) &gt; [InvocationContext](./context.invocationcontext.md) &gt; [args](./context.invocationcontext.args.md)
+
+## InvocationContext.args property
+
+**Signature:**
+
+```typescript
+readonly args: InvocationArgs;
+```
+

package/site/apidocs/context.invocationcontext.assertmethodexists.md

@@ -0,0 +1,27 @@
+---
+lang: en
+title: 'API docs: context.invocationcontext.assertmethodexists'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/context
+permalink: /doc/en/lb4/apidocs.context.invocationcontext.assertmethodexists.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/context](./context.md) &gt; [InvocationContext](./context.invocationcontext.md) &gt; [assertMethodExists](./context.invocationcontext.assertmethodexists.md)
+
+## InvocationContext.assertMethodExists() method
+
+Assert the method exists on the target. An error will be thrown if otherwise.
+
+**Signature:**
+
+```typescript
+assertMethodExists(): Record<string, Function>;
+```
+**Returns:**
+
+Record&lt;string, Function&gt;
+
+

package/site/apidocs/context.invocationcontext.description.md

@@ -0,0 +1,23 @@
+---
+lang: en
+title: 'API docs: context.invocationcontext.description'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/context
+permalink: /doc/en/lb4/apidocs.context.invocationcontext.description.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/context](./context.md) &gt; [InvocationContext](./context.invocationcontext.md) &gt; [description](./context.invocationcontext.description.md)
+
+## InvocationContext.description property
+
+Description of the invocation
+
+**Signature:**
+
+```typescript
+get description(): string;
+```
+

package/site/apidocs/context.invocationcontext.invoketargetmethod.md

@@ -0,0 +1,34 @@
+---
+lang: en
+title: 'API docs: context.invocationcontext.invoketargetmethod'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/context
+permalink: /doc/en/lb4/apidocs.context.invocationcontext.invoketargetmethod.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/context](./context.md) &gt; [InvocationContext](./context.invocationcontext.md) &gt; [invokeTargetMethod](./context.invocationcontext.invoketargetmethod.md)
+
+## InvocationContext.invokeTargetMethod() method
+
+Invoke the target method with the given context
+
+**Signature:**
+
+```typescript
+invokeTargetMethod(options?: InvocationOptions): any;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | [InvocationOptions](./context.invocationoptions.md) | _(Optional)_ Options for the invocation |
+
+**Returns:**
+
+any
+
+

package/site/apidocs/context.invocationcontext.md

@@ -0,0 +1,51 @@
+---
+lang: en
+title: 'API docs: context.invocationcontext'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/context
+permalink: /doc/en/lb4/apidocs.context.invocationcontext.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/context](./context.md) &gt; [InvocationContext](./context.invocationcontext.md)
+
+## InvocationContext class
+
+InvocationContext represents the context to invoke interceptors for a method. The context can be used to access metadata about the invocation as well as other dependencies.
+
+**Signature:**
+
+```typescript
+export declare class InvocationContext extends Context 
+```
+**Extends:** [Context](./context.context.md)
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(parent, target, methodName, args, source)](./context.invocationcontext._constructor_.md) |  | Construct a new instance of <code>InvocationContext</code> |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [args](./context.invocationcontext.args.md) | <code>readonly</code> | [InvocationArgs](./context.invocationargs.md) |  |
+|  [description](./context.invocationcontext.description.md) | <code>readonly</code> | string | Description of the invocation |
+|  [methodName](./context.invocationcontext.methodname.md) | <code>readonly</code> | string |  |
+|  [source?](./context.invocationcontext.source.md) | <code>readonly</code> | [InvocationSource](./context.invocationsource.md)<!-- -->&lt;unknown&gt; \| undefined | _(Optional)_ |
+|  [target](./context.invocationcontext.target.md) | <code>readonly</code> | object |  |
+|  [targetClass](./context.invocationcontext.targetclass.md) | <code>readonly</code> | Function | The target class, such as <code>OrderController</code> |
+|  [targetName](./context.invocationcontext.targetname.md) | <code>readonly</code> | string | The target name, such as <code>OrderController.prototype.cancelOrder</code> |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [assertMethodExists()](./context.invocationcontext.assertmethodexists.md) |  | Assert the method exists on the target. An error will be thrown if otherwise. |
+|  [invokeTargetMethod(options)](./context.invocationcontext.invoketargetmethod.md) |  | Invoke the target method with the given context |
+|  [toString()](./context.invocationcontext.tostring.md) |  |  |
+
+

package/site/apidocs/context.invocationcontext.methodname.md

@@ -0,0 +1,21 @@
+---
+lang: en
+title: 'API docs: context.invocationcontext.methodname'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/context
+permalink: /doc/en/lb4/apidocs.context.invocationcontext.methodname.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/context](./context.md) &gt; [InvocationContext](./context.invocationcontext.md) &gt; [methodName](./context.invocationcontext.methodname.md)
+
+## InvocationContext.methodName property
+
+**Signature:**
+
+```typescript
+readonly methodName: string;
+```
+

package/site/apidocs/context.invocationcontext.source.md

@@ -0,0 +1,21 @@
+---
+lang: en
+title: 'API docs: context.invocationcontext.source'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/context
+permalink: /doc/en/lb4/apidocs.context.invocationcontext.source.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/context](./context.md) &gt; [InvocationContext](./context.invocationcontext.md) &gt; [source](./context.invocationcontext.source.md)
+
+## InvocationContext.source property
+
+**Signature:**
+
+```typescript
+readonly source?: InvocationSource<unknown> | undefined;
+```
+

package/site/apidocs/context.invocationcontext.target.md

@@ -0,0 +1,21 @@
+---
+lang: en
+title: 'API docs: context.invocationcontext.target'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/context
+permalink: /doc/en/lb4/apidocs.context.invocationcontext.target.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/context](./context.md) &gt; [InvocationContext](./context.invocationcontext.md) &gt; [target](./context.invocationcontext.target.md)
+
+## InvocationContext.target property
+
+**Signature:**
+
+```typescript
+readonly target: object;
+```
+

package/site/apidocs/context.invocationcontext.targetclass.md

@@ -0,0 +1,23 @@
+---
+lang: en
+title: 'API docs: context.invocationcontext.targetclass'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/context
+permalink: /doc/en/lb4/apidocs.context.invocationcontext.targetclass.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/context](./context.md) &gt; [InvocationContext](./context.invocationcontext.md) &gt; [targetClass](./context.invocationcontext.targetclass.md)
+
+## InvocationContext.targetClass property
+
+The target class, such as `OrderController`
+
+**Signature:**
+
+```typescript
+get targetClass(): Function;
+```
+

package/site/apidocs/context.invocationcontext.targetname.md

@@ -0,0 +1,23 @@
+---
+lang: en
+title: 'API docs: context.invocationcontext.targetname'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/context
+permalink: /doc/en/lb4/apidocs.context.invocationcontext.targetname.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/context](./context.md) &gt; [InvocationContext](./context.invocationcontext.md) &gt; [targetName](./context.invocationcontext.targetname.md)
+
+## InvocationContext.targetName property
+
+The target name, such as `OrderController.prototype.cancelOrder`
+
+**Signature:**
+
+```typescript
+get targetName(): string;
+```
+

package/site/apidocs/context.invocationcontext.tostring.md

@@ -0,0 +1,25 @@
+---
+lang: en
+title: 'API docs: context.invocationcontext.tostring'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/context
+permalink: /doc/en/lb4/apidocs.context.invocationcontext.tostring.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/context](./context.md) &gt; [InvocationContext](./context.invocationcontext.md) &gt; [toString](./context.invocationcontext.tostring.md)
+
+## InvocationContext.toString() method
+
+**Signature:**
+
+```typescript
+toString(): string;
+```
+**Returns:**
+
+string
+
+

package/site/apidocs/context.invocationoptions.md

@@ -0,0 +1,30 @@
+---
+lang: en
+title: 'API docs: context.invocationoptions'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/context
+permalink: /doc/en/lb4/apidocs.context.invocationoptions.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/context](./context.md) &gt; [InvocationOptions](./context.invocationoptions.md)
+
+## InvocationOptions type
+
+Options to control invocations
+
+**Signature:**
+
+```typescript
+export type InvocationOptions = {
+    skipParameterInjection?: boolean;
+    skipInterceptors?: boolean;
+    source?: InvocationSource;
+    session?: ResolutionSession;
+};
+```
+**References:** [InvocationSource](./context.invocationsource.md)<!-- -->, [ResolutionSession](./context.resolutionsession.md)
+
+

package/site/apidocs/context.invocationresult.md

@@ -0,0 +1,23 @@
+---
+lang: en
+title: 'API docs: context.invocationresult'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/context
+permalink: /doc/en/lb4/apidocs.context.invocationresult.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/context](./context.md) &gt; [InvocationResult](./context.invocationresult.md)
+
+## InvocationResult type
+
+Return value for a method invocation
+
+**Signature:**
+
+```typescript
+export type InvocationResult = any;
+```
+

package/site/apidocs/context.invocationsource.md

@@ -0,0 +1,31 @@
+---
+lang: en
+title: 'API docs: context.invocationsource'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/context
+permalink: /doc/en/lb4/apidocs.context.invocationsource.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/context](./context.md) &gt; [InvocationSource](./context.invocationsource.md)
+
+## InvocationSource interface
+
+An interface to represent the caller of the invocation
+
+**Signature:**
+
+```typescript
+export interface InvocationSource<T = unknown> 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [type](./context.invocationsource.type.md) | <code>readonly</code> | string | Type of the invoker, such as <code>proxy</code> and <code>route</code> |
+|  [value](./context.invocationsource.value.md) | <code>readonly</code> | T | Metadata for the source, such as <code>ResolutionSession</code> |
+
+

package/site/apidocs/context.invocationsource.type.md

@@ -0,0 +1,23 @@
+---
+lang: en
+title: 'API docs: context.invocationsource.type'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/context
+permalink: /doc/en/lb4/apidocs.context.invocationsource.type.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/context](./context.md) &gt; [InvocationSource](./context.invocationsource.md) &gt; [type](./context.invocationsource.type.md)
+
+## InvocationSource.type property
+
+Type of the invoker, such as `proxy` and `route`
+
+**Signature:**
+
+```typescript
+readonly type: string;
+```
+

package/site/apidocs/context.invocationsource.value.md

@@ -0,0 +1,23 @@
+---
+lang: en
+title: 'API docs: context.invocationsource.value'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/context
+permalink: /doc/en/lb4/apidocs.context.invocationsource.value.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/context](./context.md) &gt; [InvocationSource](./context.invocationsource.md) &gt; [value](./context.invocationsource.value.md)
+
+## InvocationSource.value property
+
+Metadata for the source, such as `ResolutionSession`
+
+**Signature:**
+
+```typescript
+readonly value: T;
+```
+

package/site/apidocs/context.invokeinterceptors.md

@@ -0,0 +1,35 @@
+---
+lang: en
+title: 'API docs: context.invokeinterceptors'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/context
+permalink: /doc/en/lb4/apidocs.context.invokeinterceptors.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/context](./context.md) &gt; [invokeInterceptors](./context.invokeinterceptors.md)
+
+## invokeInterceptors() function
+
+Invoke a chain of interceptors with the context
+
+**Signature:**
+
+```typescript
+export declare function invokeInterceptors<C extends Context = Context, T = InvocationResult>(context: C, interceptors: GenericInterceptorOrKey<C>[]): ValueOrPromise<T | undefined>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  context | C | Context object |
+|  interceptors | [GenericInterceptorOrKey](./context.genericinterceptororkey.md)<!-- -->&lt;C&gt;\[\] | An array of interceptor functions or binding keys |
+
+**Returns:**
+
+[ValueOrPromise](./context.valueorpromise.md)<!-- -->&lt;T \| undefined&gt;
+
+

package/site/apidocs/context.invokemethod.md

@@ -0,0 +1,38 @@
+---
+lang: en
+title: 'API docs: context.invokemethod'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/context
+permalink: /doc/en/lb4/apidocs.context.invokemethod.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/context](./context.md) &gt; [invokeMethod](./context.invokemethod.md)
+
+## invokeMethod() function
+
+Invoke a method using dependency injection. Interceptors are invoked as part of the invocation.
+
+**Signature:**
+
+```typescript
+export declare function invokeMethod(target: object, method: string, ctx: Context, nonInjectedArgs?: InvocationArgs, options?: InvocationOptions): ValueOrPromise<InvocationResult>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  target | object | Target of the method, it will be the class for a static method, and instance or class prototype for a prototype method |
+|  method | string | Name of the method |
+|  ctx | [Context](./context.context.md) | Context object |
+|  nonInjectedArgs | [InvocationArgs](./context.invocationargs.md) | _(Optional)_ Optional array of args for non-injected parameters |
+|  options | [InvocationOptions](./context.invocationoptions.md) | _(Optional)_ Options for the invocation |
+
+**Returns:**
+
+[ValueOrPromise](./context.valueorpromise.md)<!-- -->&lt;[InvocationResult](./context.invocationresult.md)<!-- -->&gt;
+
+

package/site/apidocs/context.invokemethodwithinterceptors.md

@@ -0,0 +1,38 @@
+---
+lang: en
+title: 'API docs: context.invokemethodwithinterceptors'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/context
+permalink: /doc/en/lb4/apidocs.context.invokemethodwithinterceptors.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/context](./context.md) &gt; [invokeMethodWithInterceptors](./context.invokemethodwithinterceptors.md)
+
+## invokeMethodWithInterceptors() function
+
+Invoke a method with the given context
+
+**Signature:**
+
+```typescript
+export declare function invokeMethodWithInterceptors(context: Context, target: object, methodName: string, args: InvocationArgs, options?: InvocationOptions): ValueOrPromise<InvocationResult>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  context | [Context](./context.context.md) | Context object |
+|  target | object | Target class (for static methods) or object (for instance methods) |
+|  methodName | string | Method name |
+|  args | [InvocationArgs](./context.invocationargs.md) | An array of argument values |
+|  options | [InvocationOptions](./context.invocationoptions.md) | _(Optional)_ Options for the invocation |
+
+**Returns:**
+
+[ValueOrPromise](./context.valueorpromise.md)<!-- -->&lt;[InvocationResult](./context.invocationresult.md)<!-- -->&gt;
+
+

package/site/apidocs/context.isbindingaddress.md

@@ -0,0 +1,34 @@
+---
+lang: en
+title: 'API docs: context.isbindingaddress'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/context
+permalink: /doc/en/lb4/apidocs.context.isbindingaddress.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/context](./context.md) &gt; [isBindingAddress](./context.isbindingaddress.md)
+
+## isBindingAddress() function
+
+Type guard for binding address
+
+**Signature:**
+
+```typescript
+export declare function isBindingAddress(bindingSelector: BindingSelector): bindingSelector is BindingAddress;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  bindingSelector | [BindingSelector](./context.bindingselector.md) | Binding key or filter function |
+
+**Returns:**
+
+bindingSelector is [BindingAddress](./context.bindingaddress.md)
+
+