piral-containers
Advanced tools
Comparing version 0.8.3 to 0.9.0-pre.739
@@ -6,3 +6,3 @@ import { Extend } from 'piral-core'; | ||
*/ | ||
export interface ContainerConfig { | ||
export interface ContainersConfig { | ||
} | ||
@@ -12,2 +12,2 @@ /** | ||
*/ | ||
export declare function createContainerApi(config?: ContainerConfig): Extend<PiletContainersApi>; | ||
export declare function createContainersApi(config?: ContainersConfig): Extend<PiletContainersApi>; |
@@ -10,3 +10,3 @@ "use strict"; | ||
*/ | ||
function createContainerApi(config = {}) { | ||
function createContainersApi(config = {}) { | ||
return context => { | ||
@@ -33,3 +33,3 @@ context.defineActions(actions); | ||
} | ||
exports.createContainerApi = createContainerApi; | ||
exports.createContainersApi = createContainersApi; | ||
//# sourceMappingURL=create.js.map |
{ | ||
"name": "piral-containers", | ||
"version": "0.8.3", | ||
"version": "0.9.0-pre.739", | ||
"description": "Extensions for pilet-global state in Piral.", | ||
@@ -39,3 +39,3 @@ "keywords": [ | ||
"devDependencies": { | ||
"piral-core": "^0.8.3" | ||
"piral-core": "^0.9.0-pre.739" | ||
}, | ||
@@ -45,3 +45,3 @@ "peerDependencies": { | ||
}, | ||
"gitHead": "0e031b4cad4c255dfde11f5f62dbc27160f26f08" | ||
"gitHead": "92414f91e86075e1bddcfcb3f838a61fee60888e" | ||
} |
@@ -5,8 +5,12 @@ [![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`. By default, these extensions are not integrated in `piral`, so you'd need to add them to your Piral instance. | ||
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`. | ||
By default, these extensions are not integrated in `piral`, so you'd need to add them to your Piral instance. | ||
## Documentation | ||
For details on the provided API check out the [documentation at the Piral website](https://docs.piral.io) or [on GitHub](https://github.com/smapiot/piral/tree/master/docs). | ||
The following functions are brought to the Pilet API. | ||
(tbd) | ||
## Setup and Bootstrapping | ||
@@ -16,6 +20,6 @@ | ||
For the setup of the library itself you'll need to import `createContainerApi` from the `piral-containers` package. | ||
For the setup of the library itself you'll need to import `createContainersApi` from the `piral-containers` package. | ||
```tsx | ||
import { createContainerApi } from 'piral-containers'; | ||
import { createContainersApi } from 'piral-containers'; | ||
``` | ||
@@ -28,3 +32,3 @@ | ||
// important part | ||
extendApi: [createContainerApi()], | ||
extendApi: [createContainersApi()], | ||
// ... | ||
@@ -31,0 +35,0 @@ }); |
@@ -10,3 +10,3 @@ import * as actions from './actions'; | ||
*/ | ||
export interface ContainerConfig {} | ||
export interface ContainersConfig {} | ||
@@ -16,3 +16,3 @@ /** | ||
*/ | ||
export function createContainerApi(config: ContainerConfig = {}): Extend<PiletContainersApi> { | ||
export function createContainersApi(config: ContainersConfig = {}): Extend<PiletContainersApi> { | ||
return context => { | ||
@@ -19,0 +19,0 @@ context.defineActions(actions); |
Sorry, the diff of this file is not supported yet
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
40
18592