# sgt-fields

> Find the property in your object with Sargent Fields

Latest version **1.2.3** (published 2019-06-22) · ISC license · 0 weekly downloads

## Install

```sh
npm install sgt-fields
pnpm add sgt-fields
yarn add sgt-fields
bun add sgt-fields
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.3 |
| Published | 2019-06-22 |
| First published | 2017-09-11 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 7.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Rodrigo Cardoso Moreira & Fernando Nardi |
| Maintainers | fenardi, rodrigocmoreira |
| Keywords | fields, object, get, set, property, array, field |

## Links

- npm: https://www.npmjs.com/package/sgt-fields
- Repository: https://github.com/rodrigocmoreira/sgt-fields
- Homepage: https://github.com/rodrigocmoreira/sgt-fields#readme
- Issues: https://github.com/rodrigocmoreira/sgt-fields/issues
- npm.io page: https://npm.io/package/sgt-fields

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 1.2.3 (latest) — 2019-06-22
- 1.2.2 — 2018-06-20
- 1.2.1 — 2018-06-20
- 1.2.0 — 2017-09-29
- 1.1.3 — 2017-09-21
- 1.1.2 — 2017-09-19
- 1.1.1 — 2017-09-16
- 1.1.0 — 2017-09-15
- 1.0.0 — 2017-09-11

## README

# sgt-fields

[![NPM](https://nodei.co/npm/sgt-fields.png)](https://nodei.co/npm/sgt-fields/)

[![NPM version](https://img.shields.io/npm/v/sgt-fields.svg)](https://www.npmjs.com/package/sgt-fields) [![Build Status](https://travis-ci.org/rodrigocmoreira/sgt-fields.svg?branch=master)](https://travis-ci.org/rodrigocmoreira/sgt-fields) [![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=sgt-fields&metric=alert_status)](https://sonarcloud.io/dashboard/index/sgt-fields) [![NPM monthly downloads](https://img.shields.io/npm/dm/sgt-fields.svg)](https://www.npmjs.com/package/sgt-fields) [![NPM total downloads](https://img.shields.io/npm/dt/sgt-fields.svg)](https://www.npmjs.com/package/sgt-fields) [![Coverage Status](https://coveralls.io/repos/github/rodrigocmoreira/sgt-fields/badge.svg?branch=master)](https://coveralls.io/github/rodrigocmoreira/sgt-fields?branch=master) [![Known Vulnerabilities](https://snyk.io/test/npm/sgt-fields/badge.svg)](https://snyk.io/test/npm/sgt-fields)

Find the property in your object with Sargent Fields

## Install

Install with [npm](https://www.npmjs.com/):

```sh
npm install sgt-fields --save
```

## Usage

```js
var sgtFields = require('sgt-fields');
```

Get property on object:

```js
var object = {
  a: {
    b: {
      c: 'test'
    }
  }
};
var result = sgtFields.get(object, 'a.b.c');
//=> result = 'test'
```

Get property on object (supported array):

```js
var object = {
  user: {
    fullName: [{
      name: 'first name'
    }, {
      name: 'second name'
    }]
  }
};
var resultFirstName = sgtFields.get(object, 'user.fullName.0.name');
//=> resultFirstName = 'first name'

var resultSecondName = sgtFields.get(object, 'user.fullName.1.name');
//=> resultSecondName = 'second name'
```

Set or add property on object:

```js
var object = {
  a: {
  }
};
var result = sgtFields.set(object, 'a.b.c', 'test');
//=> result = { a: { b: { c: 'test' } } }
//=> object = { a: { b: { c: 'test' } } }
```

Loop through each property on object:

```js
var object = {
  name: 'Fields',
  rank: 'Sgt',
  personalInfo: {
    phone: '987654321',
    email: 'sgt-fields@sgt-fields.com'
  }
};

sgtFields.each(object, (field, value) => {
  console.log(field, value);
});
//=> name Fields
//=> rank Sgt
//=> personalInfo { phone: '987654321', email: 'sgt-fields@sgt-fields.com' }
```

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