to-keypath

to-keypath

Convert a string keypath from an array of keys

Usage

import {toKeypath} from 'to-keypath';

let path = ['a', 'b', 'c'];
let keypath = toKeypath(path); // 'a.b.c'

// valid integers are represented in brackets
// strings which cannot be used w/ dot notation are wrapped in brackets & double-quotes
path = ['a', '0', '.c'];
keypath = toKeypath(path); // 'a[0].["."].c'

to-keypath is distributed as a dual ESM/CJS package, courtesy of tshy.

Motivation

There are tens of packages that do the inverse of this operation. Others return a value within an object when provided a string or string array. The reason for this, presumably, is that the most common relevant use case for these "keypath" strings is access or assignment to some deeply-nested property within an object.

This package does not do any of that. to-keypath just gives you a string. It does not consider the data structure to which the string would be applied, returns no values and performs no validation.

It's probably useless to you unless your program outputs the resulting string (my use case) or you are consuming an ill-conceived API which a string only. If the latter, please read the following warning:

[!WARNING]

If you're trying to pass the result of to-keypath's value to another API, understand that this package is not meant to be used as such a workaround; you are probably making a mistake and are strongly discouraged from using to-keypath in such a way.

License

©️ 2024 Christopher "boneskull" Hiller. Licensed Apache-2.0