Make sure the open source you're using is safe to use
@meterio/flex
v0.5.2Standard interface to connect DApp with Meter and user
npm install @meterio/flex
We couldn't find any similar packages Browse all packages
Package Health Score
56 / 100
- Popularity Limited
- Maintenance Sustainable
- Security No known security issues
- Community Limited
Make sure the open source you're using is safe to usePopularity
Limited
Weekly Downloads (128)- Dependents
- 2
- GitHub Stars
- 0
- Forks
- 0
- Contributors
- 1
The npm package @meterio/flex receives a total of 128 downloads a week. As such, we scored @meterio/flex popularity level to be Limited.
Based on project statistics from the GitHub repository for the npm package @meterio/flex, we found that it has been starred ? times, and that 2 other projects on the ecosystem are dependent on it.
Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.
Security
No known security issues
Security and license risk for significant versions
All VersionsDirect Vulnerabilities
0.4.11
0.5.2
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
Indirect Vulnerabilities
0.4.11
0.5.2
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
All security vulnerabilities belong to
production dependencies of direct and indirect
packages.
- Security Policy
- No
Snyk detected that the latest version of @meterio/flex has a security vulnerability.
We highly advise you to review these security issues.
You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.
We found a way for you to contribute to the project! Looks like @meterio/flex is missing a security policy.
# Install the Snyk CLI and test your project
npm i snyk && snyk test @meterio/flex
Maintenance
Sustainable
Commit Frequency- Open Issues
- 0
- Merged PR
- 0
- Open PR
- 0
- Last Commit
- 1 month ago
Further analysis of the maintenance status of @meterio/flex based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.
We found that @meterio/flex demonstrates a positive version release cadence with at least one new version released in the past 3 months.
In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.
Community
Limited
- Readme.md
- Yes
- Contributing.md
- No
- Code of Conduct
- No
- Contributors
- 1
- Funding
- No
- License
- LGPL-3.0
This project has seen only 10 or less contributors.
We found a way for you to contribute to the project! Looks like @meterio/flex is missing a Code of Conduct.
We noticed that this project uses a license which requires less permissive conditions such as disclosing the source code, stating changes or redistributing the source under the same license. It is advised to further consult the license terms before use.
Embed Package Health Score Badge
Package
- Node.js Compatibility
- not defined
- Age
- 10 months
- Dependencies
- 0 Direct / 0 Total
- Versions
- 15
- Install Size
- 32.5 kB
- Dist-tags
- 1
- # of Files
- 6
- Maintainers
- 1
- TS Typings
- Yes
@meterio/flex has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.
Flex
Introduction
Meter-Flex is the standard interface to connect DApps with Meter blockchain and user. Flex is a set of well-designed APIs for developers, with injected Flex Object in web applications they can easily build decentralized applications.
Get Started
Meter Wallet or other compatible clients will expose flex API by an injected object on Window Object.
Meter App Bootstrapping
Meter apps are usually web apps. On app load, you always need to detect Flex component. If Flex is not available, you may instruct people to setup Flex environment.
To simplify these steps, simply perform redirection:
if (!window.flex) {
location.href = 'https://shoal.meter.io/r/#' + encodeURIComponent(location.href);
}
Additionally, network can be specified:
if (!window.flex) {
// the app prefers running on test net
location.href = 'https://shoal.meter.io/r/#/test/' + encodeURIComponent(location.href);
}
Install
TypeScript(Recommended)
npm install @meterio/flex --save-dev
Place following line in any .ts file of your project
import '@meterio/flex';
or
add meter-flex to compilerOptions.types in tsconfig.json then you are good to go!
Vanilla JS
No need to set up, just code in your favourite way.
Usage
const el = document.createElement('h1');
const status = flex.meter.status;
el.innerText =
"You are 'flexed' to meter, the status is " + (status.progress === 1 ? 'synced' : 'syncing');
document.querySelector('body').append(el);
Resource
FAQ
TypeScript complier does not find Flex
First, check tsconfig.json and make sure meter-flex is present in compilerOptions.types. Furthermore if you are doing an angular project and still get the error, you are probably using a larger project with multiple project roots, just adding meter-flex to the root config is not enough in this case. You also have to find all tsconfig.app.ts and tsconfig.spec.ts files in your sub-projects. While these inherit from the main tsconfig.json you have to make sure it does not override the types with for example "types": [] and that there is no conflict with typesRoots
License
Flex is licensed under the GNU Lesser General Public License v3.0, also included in LICENSE file in the repository.
@meterio/flex versions
| Version | Published | Tag | Node.js Compatability | Licenses | Dependencies | Direct Vulnerabilities | Publisher |
|---|---|---|---|---|---|---|---|
| 0.5.2 | 06 January 2021 | latest | * | LGPL-3.0 | 0 |
| simonzg |
| 0.4.11 | 15 December 2020 | * | LGPL-3.0 | 0 |
| simonzg | |
| All Versions | |||||||
@meterio/flex dependencies
Last updated on
11 January-2021, at 14:44 (UTC).