mirror of
https://github.com/lucaspalomodevelop/varkeeper.git
synced 2026-03-12 23:37:21 +00:00
change readme
This commit is contained in:
parent
ab9538fc1f
commit
064f46b6aa
83
README.md
83
README.md
@ -1,10 +1,14 @@
|
||||
# varkeeper
|
||||
   [](https://www.npmjs.com/package/varkeeper)
|
||||
# varkeeper
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
[](https://www.npmjs.com/package/varkeeper)
|
||||
|
||||
## Desciption
|
||||
varkeeper is A tool for handle vars global
|
||||
|
||||
varkeeper is A tool for handle vars global in different modules
|
||||
|
||||
## Usage
|
||||
|
||||
@ -15,8 +19,79 @@ You can colormizer install using [npm](https://www.npmjs.com/package/varkeeper)
|
||||
```
|
||||
npm install varkeeper
|
||||
```
|
||||
|
||||
```
|
||||
yarn add varkeeper
|
||||
```
|
||||
|
||||
|
||||
```javascript
|
||||
var vk = require('varkeeper');
|
||||
```
|
||||
## Functional
|
||||
|
||||
### set propertie
|
||||
|
||||
```javascript
|
||||
vk.setprop("varName", "varValue");
|
||||
```
|
||||
|
||||
### get propertie
|
||||
|
||||
```javascript
|
||||
vk.getprop("varName");
|
||||
```
|
||||
|
||||
### events
|
||||
|
||||
```javascript
|
||||
vk.on("eventType",'varName', function(value){
|
||||
//do something
|
||||
}
|
||||
```
|
||||
|
||||
evnetTypes:
|
||||
|
||||
- set
|
||||
- get
|
||||
- change
|
||||
|
||||
## OOP
|
||||
|
||||
## init propertie
|
||||
|
||||
```javascript
|
||||
var vkObj = new vk.Prop("varName", "varValue");
|
||||
```
|
||||
|
||||
## reference on exist propertie
|
||||
|
||||
```javascript
|
||||
var vkObj = new vk.Prop("varName");
|
||||
```
|
||||
|
||||
### set propertie
|
||||
|
||||
```javascript
|
||||
vkObj.set("varValue");
|
||||
```
|
||||
|
||||
### get propertie
|
||||
|
||||
```javascript
|
||||
var vkObj = new vk.Prop("varName", "varValue");
|
||||
vkObj.get();
|
||||
```
|
||||
|
||||
### events
|
||||
|
||||
```javascript
|
||||
vkObj.on("eventType", function (value) {
|
||||
//do something
|
||||
});
|
||||
```
|
||||
|
||||
evnetTypes:
|
||||
|
||||
- set
|
||||
- get
|
||||
- change
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "varkeeper",
|
||||
"version": "1.0.3",
|
||||
"description": "varkeeper is A tool for handle vars global ",
|
||||
"version": "2.0.0",
|
||||
"description": "varkeeper is A tool for handle vars global in different modules ",
|
||||
"main": "dist/index.js",
|
||||
"files": [
|
||||
"dist",
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user