@ethlete/core 5.0.0-next.38 → 5.0.0-next.39

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @ethlete/core
 
+## 5.0.0-next.39
+
+### Patch Changes
+
+- [`74850e3`](https://github.com/ethlete-io/ethdk/commit/74850e3a62339565c13bdeb89c4334993eefd2b3) Thanks [@TomTomB](https://github.com/TomTomB)! - The provider-definition doc comments no longer spell the pure annotation out verbatim, so Rollup stops warning about (and stripping) an annotation it cannot attach to a call while bundling `@ethlete/core`.
+
 ## 5.0.0-next.38
 
 ### Minor Changes

package/fesm2022/ethlete-core.mjs

@@ -175,7 +175,15 @@ const createProviders = (token, factory, extraToken) => [
     { provide: token, useFactory: factory },
     ...(extraToken ? [{ provide: extraToken, useExisting: token }] : []),
 ];
-
+/**
+ * Defines a provider that a subtree opts into - `provideX()` in some component's `providers`, then
+ * `injectX()` below it. Nothing is created until the subtree provides it.
+ *
+ * Assign the result to one `const`, name the halves with {@link toProvideFn} / {@link toInjectFn} /
+ * {@link toToken}, and put a `__PURE__` annotation comment on each of those declarations. Never destructure
+ * the definition: that declaration cannot be tree-shaken, so it ships the factory's whole closure to
+ * every consumer. Enforced by `ethlete/no-impure-top-level-provider`.
+ */
 const defineProvider = (factory, options) => {
     const token = new InjectionToken(options?.name ?? createComponentId('provider'));
     return {
@@ -226,7 +234,7 @@ const defineStaticRootProvider = (defaultValue, options) => {
         token,
     };
 };
-
+/** The `provideX` half of a provider definition. A call, so a `__PURE__` annotation makes it droppable. */
 const toProvideFn = (definition) => definition.provide;
 /** The `injectX` half of a provider definition. */
 const toInjectFn = (definition) => definition.inject;