https://github.com/arlac77/model-attributes

attribute meta description
https://github.com/arlac77/model-attributes

meta-model

Last synced: 3 months ago
JSON representation

attribute meta description

• Host: GitHub
• URL: https://github.com/arlac77/model-attributes
• Owner: arlac77
• License: 0bsd
• Created: 2016-05-20T11:39:17.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2025-07-15T15:02:57.000Z (11 months ago)
• Last Synced: 2025-07-16T00:36:41.154Z (11 months ago)
• Topics: meta-model
• Language: JavaScript
• Homepage:
• Size: 2.43 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![npm](https://img.shields.io/npm/v/model-attributes.svg)](https://www.npmjs.com/package/model-attributes)

[![License](https://img.shields.io/badge/License-0BSD-blue.svg)](https://spdx.org/licenses/0BSD.html)

[![bundlejs](https://deno.bundlejs.com/?q=model-attributes\&badge=detailed)](https://bundlejs.com/?q=model-attributes)

[![downloads](http://img.shields.io/npm/dm/model-attributes.svg?style=flat-square)](https://npmjs.org/package/model-attributes)

[![GitHub Issues](https://img.shields.io/github/issues/arlac77/model-attributes.svg?style=flat-square)](https://github.com/arlac77/model-attributes/issues)

[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Farlac77%2Fmodel-attributes%2Fbadge\&style=flat)](https://actions-badge.atrox.dev/arlac77/model-attributes/goto)

[![Styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

[![Known Vulnerabilities](https://snyk.io/test/github/arlac77/model-attributes/badge.svg)](https://snyk.io/test/github/arlac77/model-attributes)

[![Coverage Status](https://coveralls.io/repos/arlac77/model-attributes/badge.svg)](https://coveralls.io/github/arlac77/model-attributes)

# model-attributes

attribute meta description

```javascript

const { createAttributes } from 'model-attributes';

const attributes = ma.createAttributes({

  att1: {},

  att2: { datault: 2}

});

const object = {};

ma.setAttributes(object, attributes, {

  att1: 'value1'

});

console.log(object.att1); // value1

console.log(object.att2); // 2

```

# API

### Table of Contents

*   [setAttributes](#setattributes)

    *   [Parameters](#parameters)

*   [getAttribute](#getattribute)

    *   [Parameters](#parameters-1)

*   [getAttributes](#getattributes)

    *   [Parameters](#parameters-2)

*   [createAttributes](#createattributes)

    *   [Parameters](#parameters-3)

*   [mergeAttributes](#mergeattributes)

    *   [Parameters](#parameters-4)

## setAttributes

Copies attribute values from a source object into a destination object.

### Parameters

*   `dest` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** target object to be modified

*   `atts` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** attribute definitions to be used

*   `src` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** origin of the data to be copied

*   `cb` **[function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** callback to be executed for each copied value

*   `prefix` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name prefix used for all attributes

Returns **void** 

## getAttribute

Delivers a attribute value for a given attribute name

### Parameters

*   `object` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** to query

*   `atts` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** attribute definitions to be used

*   `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** attribute name

Returns **Any** attribute value

## getAttributes

Retrive attribute values from an object.

### Parameters

*   `object` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** attribute value source

*   `attributes` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 

Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** values

## createAttributes

Create attributes from its definition.

### Parameters

*   `definitions` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 

Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** attributes

## mergeAttributes

Merge attribute definitions.

### Parameters

*   `dest` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** attribute definitions to be used also the merge target

*   `atts` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** attribute definitions to be used

Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** merged definitions (dest)

# install

With [npm](http://npmjs.org) do:

```shell

npm install model-attributes

```

# license

# BSD-2-Clause