@fluidframework/core-interfaces 2.0.0-internal.6.3.3 → 2.0.0-internal.6.4.0

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.
Files changed (51) hide show
  1. package/.eslintrc.js +1 -1
  2. package/CHANGELOG.md +4 -0
  3. package/dist/error.d.ts.map +1 -1
  4. package/dist/error.js.map +1 -1
  5. package/dist/events.d.ts +2 -0
  6. package/dist/events.d.ts.map +1 -1
  7. package/dist/events.js.map +1 -1
  8. package/dist/fluidLoadable.d.ts.map +1 -1
  9. package/dist/fluidLoadable.js.map +1 -1
  10. package/dist/fluidPackage.d.ts +1 -1
  11. package/dist/fluidPackage.d.ts.map +1 -1
  12. package/dist/fluidPackage.js +4 -1
  13. package/dist/fluidPackage.js.map +1 -1
  14. package/dist/fluidRouter.d.ts.map +1 -1
  15. package/dist/fluidRouter.js.map +1 -1
  16. package/dist/index.js +1 -1
  17. package/dist/index.js.map +1 -1
  18. package/dist/logger.d.ts.map +1 -1
  19. package/dist/logger.js.map +1 -1
  20. package/dist/provider.d.ts +11 -4
  21. package/dist/provider.d.ts.map +1 -1
  22. package/dist/provider.js.map +1 -1
  23. package/lib/error.d.ts.map +1 -1
  24. package/lib/error.js.map +1 -1
  25. package/lib/events.d.ts +2 -0
  26. package/lib/events.d.ts.map +1 -1
  27. package/lib/events.js.map +1 -1
  28. package/lib/fluidLoadable.d.ts.map +1 -1
  29. package/lib/fluidLoadable.js.map +1 -1
  30. package/lib/fluidPackage.d.ts +1 -1
  31. package/lib/fluidPackage.d.ts.map +1 -1
  32. package/lib/fluidPackage.js +4 -1
  33. package/lib/fluidPackage.js.map +1 -1
  34. package/lib/fluidRouter.d.ts.map +1 -1
  35. package/lib/fluidRouter.js.map +1 -1
  36. package/lib/index.js +1 -1
  37. package/lib/index.js.map +1 -1
  38. package/lib/logger.d.ts.map +1 -1
  39. package/lib/logger.js.map +1 -1
  40. package/lib/provider.d.ts +11 -4
  41. package/lib/provider.d.ts.map +1 -1
  42. package/lib/provider.js.map +1 -1
  43. package/package.json +2 -2
  44. package/src/error.ts +3 -0
  45. package/src/events.ts +2 -0
  46. package/src/fluidLoadable.ts +2 -0
  47. package/src/fluidPackage.ts +5 -2
  48. package/src/fluidRouter.ts +6 -0
  49. package/src/index.ts +1 -1
  50. package/src/logger.ts +4 -2
  51. package/src/provider.ts +11 -4
package/src/provider.ts CHANGED
@@ -4,13 +4,18 @@
4
4
  */
5
5
 
6
6
  /**
7
- * This utility type is meant for internal use by {@link FluidObject}
8
7
  * Produces a valid FluidObject key given a type and a property.
8
+ *
9
+ * @remarks
10
+ *
9
11
  * A valid FluidObject key is a property that exists on the incoming type
10
12
  * as well as on the type of the property itself. For example: `IProvideFoo.IFoo.IFoo`
11
13
  * This aligns with the FluidObject pattern expected to be used with all FluidObjects.
12
14
  *
15
+ * This utility type is meant for internal use by {@link FluidObject}
16
+ *
13
17
  * @example
18
+ *
14
19
  * ```typescript
15
20
  * interface IProvideFoo{
16
21
  * IFoo: IFoo
@@ -19,9 +24,9 @@
19
24
  * foobar();
20
25
  * }
21
26
  * ```
22
- * This pattern enables discovery, and delegation in a standard way which is central
23
- * to FluidObject pattern
24
27
  *
28
+ * This pattern enables discovery, and delegation in a standard way which is central
29
+ * to FluidObject pattern.
25
30
  */
26
31
  export type FluidObjectProviderKeys<T, TProp extends keyof T = keyof T> = string extends TProp
27
32
  ? never
@@ -42,7 +47,9 @@ export type FluidObjectProviderKeys<T, TProp extends keyof T = keyof T> = string
42
47
  * FluidObject without a generic argument.
43
48
  *
44
49
  * @example
45
- * For example, if we have an interface like below
50
+ *
51
+ * For example, if we have an interface like the following:
52
+ *
46
53
  * ```typescript
47
54
  * interface IProvideFoo{
48
55
  * IFoo: IFoo