@loopback/docs/site/apidocs/context.comparebindingsbytag.md

Documentation files rendered at [https://loopback.io](https://loopback.io)

---
lang: en
title: 'API docs: context.comparebindingsbytag'
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.comparebindingsbytag.html
---

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@loopback/context](./context.md) &gt; [compareBindingsByTag](./context.comparebindingsbytag.md)

## compareBindingsByTag() function

Creates a binding compare function to sort bindings by tagged phase name.

**Signature:**

```typescript
export declare function compareBindingsByTag(phaseTagName?: string, orderOfPhases?: (string | symbol)[]): BindingComparator;
```

## Parameters

<table><thead><tr><th>

Parameter


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td markdown="1">

phaseTagName


</td><td markdown="1">

string


</td><td markdown="1">

_(Optional)_ Name of the binding tag for phase


</td></tr>
<tr><td markdown="1">

orderOfPhases


</td><td markdown="1">

(string \| symbol)\[\]


</td><td markdown="1">

_(Optional)_ An array of phase names as the predefined order


</td></tr>
</tbody></table>

**Returns:**

[BindingComparator](./context.bindingcomparator.md)

## Remarks

Two bindings are compared as follows:

1. Get values for the given tag as `phase` for bindings, if the tag is not present, default `phase` to `''`<!-- -->. 2. If both bindings have `phase` value in `orderOfPhases`<!-- -->, honor the order specified by `orderOfPhases`<!-- -->. 3. If a binding's `phase` does not exist in `orderOfPhases`<!-- -->, it comes before the one with `phase` exists in `orderOfPhases`<!-- -->. 4. If both bindings have `phase` value outside of `orderOfPhases`<!-- -->, they are ordered by phase names alphabetically and symbol values come before string values.