Function search

Search for data in a JSON object using a JMESPath expression.

Example

import { search } from '@aws-lambda-powertools/jmespath';

const data = {
  foo: {
    bar: {
      baz: 1
    }
  }
};

const result = search('foo.bar.baz', data);
console.log(result); // 1
Copy

By default the search function will use all the built-in functions present in the JMESPath specification.

Powertools for AWS Lambda provides some additional functions that can be used by passing them in the customFunctions option.

Example

import { search } from '@aws-lambda-powertools/jmespath';
import { PowertoolsFunctions } from '@aws-lambda-powertools/jmespath/functions';

const data = {
  body: "{\"foo\": \"bar\"}"
};

const result = search(
  'powertools_json(body)',
  data,
  { customFunctions: new PowertoolsFunctions() }
);
console.log(result); // { foo: 'bar' }
Copy