piral-containers
Advanced tools
Comparing version 0.9.0-pre.763 to 0.9.0-pre.765
import { Extend } from 'piral-core'; | ||
import { PiletContainersApi } from './types'; | ||
/** | ||
* Available configuration options for the container extension. | ||
* Available configuration options for the container plugin. | ||
*/ | ||
@@ -9,4 +9,4 @@ export interface ContainersConfig { | ||
/** | ||
* Creates a new Piral API extension for supporting Pilet global state containers. | ||
* Creates new Pilet API extensions for supporting pilet global state containers. | ||
*/ | ||
export declare function createContainersApi(config?: ContainersConfig): Extend<PiletContainersApi>; |
@@ -8,3 +8,3 @@ "use strict"; | ||
/** | ||
* Creates a new Piral API extension for supporting Pilet global state containers. | ||
* Creates new Pilet API extensions for supporting pilet global state containers. | ||
*/ | ||
@@ -11,0 +11,0 @@ function createContainersApi(config = {}) { |
{ | ||
"name": "piral-containers", | ||
"version": "0.9.0-pre.763", | ||
"description": "Extensions for pilet-global state in Piral.", | ||
"version": "0.9.0-pre.765", | ||
"description": "Plugin for creating a pilet state container in Piral.", | ||
"keywords": [ | ||
@@ -12,3 +12,3 @@ "piral", | ||
"api", | ||
"extension", | ||
"plugin", | ||
"state", | ||
@@ -40,3 +40,3 @@ "containers" | ||
"devDependencies": { | ||
"piral-core": "^0.9.0-pre.763" | ||
"piral-core": "^0.9.0-pre.765" | ||
}, | ||
@@ -46,3 +46,3 @@ "peerDependencies": { | ||
}, | ||
"gitHead": "244d493ecf0c7986e549b0ee2fe48feb20c52cd9" | ||
"gitHead": "81e14b202558d9c3bcf2f8bfdf0b758d0b4b1043" | ||
} |
@@ -5,5 +5,5 @@ [![Piral Logo](https://github.com/smapiot/piral/raw/master/docs/assets/logo.png)](https://piral.io) | ||
This is an extension library that only has a peer dependency to `piral-core`. What `piral-containers` brings to the table is a set of API extensions that can be used with `piral` or `piral-core`. | ||
This is a plugin that only has a peer dependency to `piral-core`. What `piral-containers` brings to the table is a set of Pilet API extensions that can be used with `piral` or `piral-core`. | ||
By default, these extensions are not integrated in `piral`, so you'd need to add them to your Piral instance. | ||
By default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance. | ||
@@ -14,4 +14,6 @@ ## Documentation | ||
(tbd) | ||
### `createState()` | ||
Creates a new pilet global state container. The state container will essentially couple to the app shell global state container. It is, however, only available for use inside the pilet. | ||
## Setup and Bootstrapping | ||
@@ -18,0 +20,0 @@ |
@@ -8,3 +8,3 @@ import * as actions from './actions'; | ||
/** | ||
* Available configuration options for the container extension. | ||
* Available configuration options for the container plugin. | ||
*/ | ||
@@ -14,3 +14,3 @@ export interface ContainersConfig {} | ||
/** | ||
* Creates a new Piral API extension for supporting Pilet global state containers. | ||
* Creates new Pilet API extensions for supporting pilet global state containers. | ||
*/ | ||
@@ -17,0 +17,0 @@ export function createContainersApi(config: ContainersConfig = {}): Extend<PiletContainersApi> { |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
18779
42