https://github.com/seniverse/fieldmask

fieldmask implements Partial Responses protocol of Google+ API in Erlang.
https://github.com/seniverse/fieldmask

erlang google-api graphql partial-responses

Last synced: 15 days ago
JSON representation

fieldmask implements Partial Responses protocol of Google+ API in Erlang.

• Host: GitHub
• URL: https://github.com/seniverse/fieldmask
• Owner: seniverse
• License: apache-2.0
• Created: 2019-05-28T07:44:52.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-05-29T10:31:47.000Z (over 5 years ago)
• Last Synced: 2024-11-16T12:38:44.049Z (about 1 month ago)
• Topics: erlang, google-api, graphql, partial-responses
• Language: Erlang
• Homepage:
• Size: 15.6 KB
• Stars: 1
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## fieldmask

[![Build Status](https://travis-ci.org/seniverse/fieldmask.svg?branch=master)](https://travis-ci.org/seniverse/fieldmask)

[![Coverage Status](https://coveralls.io/repos/github/seniverse/fieldmask/badge.svg?branch=master)](https://coveralls.io/github/seniverse/fieldmask?branch=master)

[![hex.pm version](https://img.shields.io/hexpm/v/fieldmask.svg)](https://hex.pm/packages/fieldmask)

[![hex.pm downloads](https://img.shields.io/hexpm/dt/fieldmask.svg)](https://hex.pm/packages/fieldmask)

![hex.pm license](https://img.shields.io/hexpm/l/fieldmask.svg)

![GitHub top language](https://img.shields.io/github/languages/top/seniverse/fieldmask.svg)

fieldmask implements [Partial Responses](https://developers.google.com/+/web/api/rest/#partial-response) protocol of Google+ API in Erlang, like [json-mask](https://www.npmjs.com/package/json-mask) in JavaScript and [jsonmask](https://pypi.org/project/jsonmask/) in Python.

Mask of fieldmask is the same as `fields` parameter of Google+ API, for example, `<<"a,b">>` means the fields you want to keep is `"a"` and `"b"`.

```

1> Mask = <<"a,b">>.

<<"a,b">>

```

And fieldmask use map object format of [jsone](https://github.com/sile/jsone) to represent a JSON value.

```

2> Value = jsone:decode(<<"{\"a\":1, \"b\": 2, \"c\": 3}">>).

#{<<"a">> => 1,<<"b">> => 2,<<"c">> => 3}.

```

Call `fieldmask:mask/2` to get the specific parts of a value you've selected.

```

3> fieldmask:mask(Mask, Value).

#{<<"a">> => 1,<<"b">> => 2}

```

### Installation

add `fieldmask` dependency to your project's `rebar.config`

```

{deps, [fieldmask]}.

```

### License

fieldmask is released under Apache 2 License. Check [LICENSE](./LICENSE) file for more information.