# support-bind-operator

> SBO

Latest version **1.0.1** (published 2026-01-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install support-bind-operator
pnpm add support-bind-operator
yarn add support-bind-operator
bun add support-bind-operator
```

## Health

**Score 45/100 (D)** — status: stable.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2026-01-15 |
| First published | 2026-01-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 8.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | me |
| Maintainers | xsfj |
| Keywords | support, bind, opeartor |

## Links

- npm: https://www.npmjs.com/package/support-bind-operator
- Repository: https://github.com/xsfj/support-bind-operator
- Homepage: https://github.com/xsfj/support-bind-operator#readme
- Issues: https://github.com/xsfj/support-bind-operator/issues
- npm.io page: https://npm.io/package/support-bind-operator

## Dependencies (9)

- [ffn](https://npm.io/package/ffn.md) ^2.1.0
- [ofn](https://npm.io/package/ofn.md) ^1.0.0
- [wfn](https://npm.io/package/wfn.md) ^1.0.0
- [is-nil](https://npm.io/package/is-nil.md) ^1.0.1
- [plainify](https://npm.io/package/plainify.md) ^1.0.0
- [array-pad](https://npm.io/package/array-pad.md) ^0.0.1
- [is-object](https://npm.io/package/is-object.md) ^1.0.2
- [fast-path-set](https://npm.io/package/fast-path-set.md) ^1.0.1
- [is-global-object](https://npm.io/package/is-global-object.md) ^1.0.0

## Recent versions

- 1.0.1 (latest) — 2026-01-15

## README

# support-bind-operator

SBO stands for Support the [Bind Operator](https://github.com/tc39/proposal-bind-operator).

Converts `value::yourFunction(arg)` to `yourFunction(value, arg)`—but lets your function support either.

Notice: this is the same as [sbo](https://github.com/lamansky/sbo) from lamansky, but uses fast-path-set instead of lodash.set as lodash.set has a vulnerability.

## Installation

```bash
npm i support-bind-operator
```

## API

The module exports a single function.

### Parameters

1. Optional: Object argument:
    * Optional: `arg` (integer): The argument index at which `this` should be inserted. Defaults to `0`.
    * Optional: `path` (string): The dot-separated key path of an options object argument located at index `arg` into which `this` should be inserted.
    * Optional: `ignoreThis` (object, array, or function): `this` is ignored if `ignoreThis` strictly equals `this`, or if `ignoreThis` is an array containing `this`, or if `ignoreThis` is a function which returns `true` when given `this`.
2. `fn` (Function): The function which should receive bind operator support.

### Return Value

A wrapper function with bind operator support that calls `fn`.

## Tutorial

Let’s say, for the sake of example, that you have a function called `addSuffix`:

```javascript
const addSuffix = (str, suffix) => str + suffix
```

You use the `support-bind-operator` module to add support for the bind operator:

```javascript
const supportBindOperator = require('support-bind-operator')
const addSuffix = supportBindOperator((str, suffix) => str + suffix)
```

Now your function can be called either the normal way or with the bind operator:

```javascript
addSuffix('Hello, world', '!') // 'Hello, world!'
'Hello, world'::addSuffix('!') // 'Hello, world!'
```

### Specifying a Parameter Index

Now let’s swap the order of the parameters:

```javascript
const addSuffix = (suffix, str) => str + suffix
```

A bound `this` would now need to become the argument with an index of 1. To do this, pass an extra argument to `support-bind-operator`:

```javascript
const supportBindOperator = require('support-bind-operator')
const addSuffix = supportBindOperator({arg: 1}, (suffix, str) => str + suffix)

addSuffix('!', 'Hello, world') // 'Hello, world!'
'Hello, world'::addSuffix('!') // 'Hello, world!'
```

### Specifying an Object Argument Key

Let’s try using a deconstructed object parameter:

```javascript
const addSuffix = ({str, suffix}) => str + suffix
```

Do the following to direct a bound `this` to the `str` key of the object argument at index zero (i.e. the first, and in this case the only, argument):

```javascript
const supportBindOperator = require('support-bind-operator')
const addSuffix = supportBindOperator({path: 'str'}, ({str, suffix}) => str + suffix)

addSuffix({str: 'Hello, world', suffix: '!'}) // 'Hello, world!'
'Hello, world'::addSuffix({suffix: '!'}) // 'Hello, world!'
```

If you have a nested object parameter, you can use a dot-separated key path.

---
_Source: https://npm.io/package/support-bind-operator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._