sample-piral 0.15.0-beta.4813 → 0.15.0-beta.4816

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/app/index.d.ts CHANGED
@@ -150,6 +150,9 @@ export interface PiletMetadata {
150
150
  * Listener for Piral app shell events.
151
151
  */
152
152
  export interface Listener<T> {
153
+ /**
154
+ * Receives an event of type T.
155
+ */
153
156
  (arg: T): void;
154
157
  }
155
158
 
@@ -364,6 +367,9 @@ export interface PiralPageMeta extends PiralCustomPageMeta, PiralCustomPageMeta
364
367
  * The shape of an implicit unregister function.
365
368
  */
366
369
  export interface RegistrationDisposer {
370
+ /**
371
+ * Cleans up the previous registration.
372
+ */
367
373
  (): void;
368
374
  }
369
375
 
@@ -386,6 +392,9 @@ export type ExtensionSlotProps<TName = string> = BaseExtensionSlotProps<TName ex
386
392
  * Can be implemented by functions to be used for disposal purposes.
387
393
  */
388
394
  export interface Disposable {
395
+ /**
396
+ * Disposes the created resource.
397
+ */
389
398
  (): void;
390
399
  }
391
400
 
@@ -500,10 +509,18 @@ export type ModalComponentProps<T> = BaseComponentProps & BareModalComponentProp
500
509
  export interface ModalLayoutOptions {}
501
510
 
502
511
  export interface FeedResolver<TData> {
512
+ /**
513
+ * Function to derive the initial set of data.
514
+ * @returns The promise for retrieving the initial data set.
515
+ */
503
516
  (): Promise<TData>;
504
517
  }
505
518
 
506
519
  export type FeedConnector<TData, TReducers = {}> = GetActions<TReducers> & {
520
+ /**
521
+ * Connector function for wrapping a component.
522
+ * @param component The component to connect by providing a data prop.
523
+ */
507
524
  <TProps>(component: React.ComponentType<TProps & FeedConnectorProps<TData>>): React.FC<TProps>;
508
525
  /**
509
526
  * Invalidates the underlying feed connector.
@@ -9604,12 +9604,12 @@ function installPiralDebug(options) {
9604
9604
  debug: debugApiVersion,
9605
9605
  instance: {
9606
9606
  name: "sample-piral",
9607
- version: "0.15.0-beta.4813",
9607
+ version: "0.15.0-beta.4816",
9608
9608
  dependencies: "reactstrap,tslib,react,react-dom,react-router,react-router-dom"
9609
9609
  },
9610
9610
  build: {
9611
- date: "2022-11-14T00:49:26.774Z",
9612
- cli: "0.15.0-beta.4813",
9611
+ date: "2022-11-14T20:49:30.425Z",
9612
+ cli: "0.15.0-beta.4816",
9613
9613
  compat: "0.15"
9614
9614
  }
9615
9615
  };
@@ -66373,4 +66373,4 @@ root.render( /*#__PURE__*/react__WEBPACK_IMPORTED_MODULE_1__.createElement(piral
66373
66373
 
66374
66374
  /******/ })()
66375
66375
  ;
66376
- //# sourceMappingURL=index.7fcc0a.js.map
66376
+ //# sourceMappingURL=index.e69005.js.map