@shopify/polaris/src/utilities/tests/pluck-deep.test.ts

Shopify’s admin product component library

import {pluckDeep} from '../pluck-deep';

describe('pluckDeep', () => {
  it('will return a value from a flat object', () => {
    const pluckedValue = pluckDeep({test: 'val', hello: 'world'}, 'hello');
    expect(pluckedValue).toBe('world');
  });

  it('will return a value from a nested structure', () => {
    const pluckedValue = pluckDeep(
      {
        aa: {
          bb: {
            cc: {
              dd: {},
            },
            ee: {ff: {}},
          },
        },
        gg: {
          hello: 'world',
        },
      },
      'hello',
    );
    expect(pluckedValue).toBe('world');
  });

  it('will return null if the key is not found', () => {
    const pluckedValue = pluckDeep(
      {
        aa: {
          bb: {
            cc: {
              dd: {},
            },
            ee: {ff: {}},
          },
        },
        gg: {
          ff: 'world',
        },
      },
      'hello',
    );
    expect(pluckedValue).toBeNull();
  });

  describe('obj argument', () => {
    it('will return null if null is supplied', () => {
      const pluckedValue = pluckDeep(null, 'hello');
      expect(pluckedValue).toBeNull();
    });
  });
});