@mozaik/ext-json
A Mozaïk extension providing generic widgets to be used to display remotely fetched json data
Last updated 2 years ago by plouc .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @mozaik/ext-json 
SYNC missed versions from official npm registry.

Mozaïk remote json widgets

This extension contains generic widgets to be used to display remotely fetched json data.

Widgets

JsonKeys

Display a list of json keys/values.

parameters

key required description
title no Override widget title, default to url value
url yes The URL to use to fetch the json
headers no An optional object containing http headers to send with the request

CustomJson

Use a template to display json data.

parameters

key required description
title no Override widget title, default to url value
url yes The URL to use to fetch the json
headers no An optional object containing http headers to send with the request
template yes The template to be used to display json data

JsonStatus

Display a status depending on json data.

parameters

key required description
title no Override widget title, default to url value
url yes The URL to use to fetch the json
headers no An optional object containing http headers to send with the request
template yes The template to be used to display json data
statuses yes An array of rules used to define current status
statuses[n].assert yes The assertion to be made on fetched json data, see format
statuses[n].status yes Resulting status if assertion is met, must be one of: unknown, success, warning, error
statuses[n].label no An optional label to put under the status icon if assertion is met

assertion format

Assertions support several types:

equals

checks that the resulting value strictly equals expectation

statuses:
  - assert: equals(my_key, status_ok)
    status: success

will check that my_key equals status_ok.

contains

checks that the resulting value contains expectation

usage:

statuses:
  - assert: contains(my_key, ok)
    status: success

will check that my_key is contains ok.

matches

checks that the resulting value matches regexp

usage:

statuses:
  - assert: matches(my_key, (ok|success)$)
    status: success

will check that my_key is a matches regexp /(ok|success)$/.

truthy

checks that the value results in a truthy value

usage:

statuses:
  - assert: truthy(my_key)
    status: success

will check that my_key is a truthy value.

falsy

checks that the value results in a falsy value

usage:

statuses:
  - assert: falsy(my_key)
    status: error

will check that my_key is a falsy value.

Current Tags

  • 0.4.0                                ...           latest (2 years ago)

4 Versions

  • 0.4.0                                ...           2 years ago
  • 0.3.0                                ...           2 years ago
  • 0.2.0                                ...           2 years ago
  • 0.1.0                                ...           2 years ago
Maintainers (2)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 2
Dependencies (5)
Dev Dependencies (22)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |