happycode-storage
Advanced tools
This requires you to have Node.js installed.
In your own Node.js environment/application:
npm install https://gitee.com/happycoding-cx/happycode-storage.git
If you want to edit/play yourself (requires Git):
git clone https://gitee.com/happycoding-cx/happycode-storage.git
cd happycode-storage
npm install
<script src="happycode-storage/dist/web/happycode-storage.js"></script>
<script>
var storage = new Happycode.Storage();
// continue to "Storage API Quick Start" section below
</script>
var storage = require('happycode-storage');
// continue to "Storage API Quick Start" section below
Once you have an instance of happycode-storage, add some web sources. For each source you'll need to provide a function
to generate a URL for a supported type of asset:
/**
* @param {Asset} asset - calculate a URL for this asset.
* @returns {string} a URL to download a project asset (PNG, WAV, etc.)
*/
var getAssetUrl = function (asset) {
var assetUrlParts = [
'https://assets.example.com/path/to/assets/',
asset.assetId,
'.',
asset.dataFormat,
'/get/'
];
return assetUrlParts.join('');
};
Then, let the storage module know about your source:
storage.addWebStore(
[AssetType.ImageVector, AssetType.ImageBitmap, AssetType.Sound],
getAssetUrl);
If you're using ES6 you may be able to simplify all of the above quite a bit:
storage.addWebStore(
[AssetType.ImageVector, AssetType.ImageBitmap, AssetType.Sound],
asset => `https://assets.example.com/path/to/assets/${asset.assetId}.${asset.dataFormat}/get/`);
Once the storage module is aware of the sources you need, you can start loading assets:
storage.load(AssetType.Sound, soundId).then(function (soundAsset) {
// `soundAsset` is an `Asset` object. File contents are stored in `soundAsset.data`.
});
If you'd like to use happycode-storage with happycode-vm you must "attach" the storage module to the VM:
vm.attachStorage(storage);
To run all tests:
npm test
To show test coverage:
npm run coverage
This project uses semantic release to ensure version bumps follow semver so that projects using the config don't break unexpectedly.
In order to automatically determine the type of version bump necessary, semantic release expects commit messages to be formatted following conventional-changelog.
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
subject and body are your familiar commit subject and body. footer is
where you would include BREAKING CHANGE and ISSUES FIXED sections if
applicable.
type is one of:
fix: A bug fix Causes a patch release (0.0.x)feat: A new feature Causes a minor release (0.x.0)docs: Documentation only changesstyle: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)refactor: A code change that neither fixes a bug nor adds a featureperf: A code change that improves performance May or may not cause a minor release. It's not clear.test: Adding missing tests or correcting existing testsci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)chore: Other changes that don't modify src or test filesrevert: Reverts a previous commitUse the commitizen CLI to make commits formatted in this way:
npm install -g commitizen
npm install
Now you're ready to make commits using git cz.
If you're committing a change that makes an API change, or will otherwise require changes to existing code, ensure your commit specifies a breaking change. In your commit body, prefix the changes with "BREAKING CHANGE: " This will cause a major version bump so downstream projects must choose to upgrade and will not break the build unexpectedly.
We provide Happycode free of charge, and want to keep it that way! Please consider making a donation to support our continued engineering, design, community, and resource development efforts. Donations of any size are appreciated. Thank you!
FAQs
Load and store project and asset files for Happycode 3.0
The npm package happycode-storage receives a total of 3 weekly downloads. As such, happycode-storage popularity was classified as not popular.
We found that happycode-storage demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
/Security News
Campaign of 108 extensions harvests identities, steals sessions, and adds backdoors to browsers, all tied to the same C2 infrastructure.
Security News
OpenAI rotated macOS signing certificates after a malicious Axios package reached its CI pipeline in a broader software supply chain attack.
Security News
Open source is under attack because of how much value it creates. It has been the foundation of every major software innovation for the last three decades. This is not the time to walk away from it.