@fluidframework/task-manager 2.0.0-rc.4.0.6 → 2.0.0-rc.5.0.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 (57) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/api-extractor/api-extractor-lint-bundle.json +5 -0
  3. package/api-extractor/api-extractor-lint-legacy.cjs.json +5 -0
  4. package/api-extractor/api-extractor-lint-legacy.esm.json +5 -0
  5. package/api-extractor/api-extractor-lint-public.cjs.json +5 -0
  6. package/api-extractor/api-extractor-lint-public.esm.json +5 -0
  7. package/api-extractor.json +1 -1
  8. package/api-report/task-manager.alpha.api.md +43 -0
  9. package/api-report/task-manager.beta.api.md +12 -0
  10. package/api-report/task-manager.public.api.md +12 -0
  11. package/biome.jsonc +4 -0
  12. package/dist/index.d.ts +1 -1
  13. package/dist/index.d.ts.map +1 -1
  14. package/dist/index.js +2 -2
  15. package/dist/index.js.map +1 -1
  16. package/dist/interfaces.d.ts +3 -3
  17. package/dist/interfaces.d.ts.map +1 -1
  18. package/dist/interfaces.js.map +1 -1
  19. package/dist/packageVersion.d.ts +1 -1
  20. package/dist/packageVersion.js +1 -1
  21. package/dist/packageVersion.js.map +1 -1
  22. package/dist/taskManager.d.ts +5 -20
  23. package/dist/taskManager.d.ts.map +1 -1
  24. package/dist/taskManager.js +9 -28
  25. package/dist/taskManager.js.map +1 -1
  26. package/dist/taskManagerFactory.d.ts +12 -2
  27. package/dist/taskManagerFactory.d.ts.map +1 -1
  28. package/dist/taskManagerFactory.js +9 -3
  29. package/dist/taskManagerFactory.js.map +1 -1
  30. package/lib/index.d.ts +1 -1
  31. package/lib/index.d.ts.map +1 -1
  32. package/lib/index.js +1 -1
  33. package/lib/index.js.map +1 -1
  34. package/lib/interfaces.d.ts +3 -3
  35. package/lib/interfaces.d.ts.map +1 -1
  36. package/lib/interfaces.js.map +1 -1
  37. package/lib/packageVersion.d.ts +1 -1
  38. package/lib/packageVersion.js +1 -1
  39. package/lib/packageVersion.js.map +1 -1
  40. package/lib/taskManager.d.ts +5 -20
  41. package/lib/taskManager.d.ts.map +1 -1
  42. package/lib/taskManager.js +3 -22
  43. package/lib/taskManager.js.map +1 -1
  44. package/lib/taskManagerFactory.d.ts +12 -2
  45. package/lib/taskManagerFactory.d.ts.map +1 -1
  46. package/lib/taskManagerFactory.js +9 -3
  47. package/lib/taskManagerFactory.js.map +1 -1
  48. package/lib/tsdoc-metadata.json +1 -1
  49. package/package.json +34 -29
  50. package/src/index.ts +1 -1
  51. package/src/interfaces.ts +6 -3
  52. package/src/packageVersion.ts +1 -1
  53. package/src/taskManager.ts +17 -33
  54. package/src/taskManagerFactory.ts +19 -6
  55. package/tsconfig.json +1 -0
  56. package/tsdoc.json +4 -0
  57. package/api-report/task-manager.api.md +0 -68
package/api-report/task-manager.api.md DELETED
@@ -1,68 +0,0 @@
1
- ## API Report File for "@fluidframework/task-manager"
2
-
3
- > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
-
5
- ```ts
6
-
7
- import { IChannelAttributes } from '@fluidframework/datastore-definitions';
8
- import { IChannelFactory } from '@fluidframework/datastore-definitions';
9
- import { IChannelStorageService } from '@fluidframework/datastore-definitions';
10
- import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
11
- import { IFluidSerializer } from '@fluidframework/shared-object-base';
12
- import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
13
- import { ISharedObject } from '@fluidframework/shared-object-base';
14
- import { ISharedObjectEvents } from '@fluidframework/shared-object-base';
15
- import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
16
- import { SharedObject } from '@fluidframework/shared-object-base/internal';
17
-
18
- // @alpha
19
- export interface ITaskManager extends ISharedObject<ITaskManagerEvents> {
20
- abandon(taskId: string): void;
21
- assigned(taskId: string): boolean;
22
- canVolunteer(): boolean;
23
- complete(taskId: string): void;
24
- queued(taskId: string): boolean;
25
- subscribed(taskId: string): boolean;
26
- subscribeToTask(taskId: string): void;
27
- volunteerForTask(taskId: string): Promise<boolean>;
28
- }
29
-
30
- // @alpha
31
- export interface ITaskManagerEvents extends ISharedObjectEvents {
32
- // @eventProperty
33
- (event: "assigned", listener: TaskEventListener): any;
34
- // @eventProperty
35
- (event: "completed", listener: TaskEventListener): any;
36
- // @eventProperty
37
- (event: "lost", listener: TaskEventListener): any;
38
- }
39
-
40
- // @alpha
41
- export type TaskEventListener = (taskId: string) => void;
42
-
43
- // @alpha @sealed
44
- export class TaskManager extends SharedObject<ITaskManagerEvents> implements ITaskManager {
45
- constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
46
- abandon(taskId: string): void;
47
- // (undocumented)
48
- protected applyStashedOp(content: any): void;
49
- assigned(taskId: string): boolean;
50
- canVolunteer(): boolean;
51
- complete(taskId: string): void;
52
- static create(runtime: IFluidDataStoreRuntime, id?: string): TaskManager;
53
- static getFactory(): IChannelFactory;
54
- // (undocumented)
55
- protected initializeLocalCore(): void;
56
- protected loadCore(storage: IChannelStorageService): Promise<void>;
57
- protected onConnect(): void;
58
- protected onDisconnect(): void;
59
- protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
60
- queued(taskId: string): boolean;
61
- protected reSubmitCore(): void;
62
- subscribed(taskId: string): boolean;
63
- subscribeToTask(taskId: string): void;
64
- protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
65
- volunteerForTask(taskId: string): Promise<boolean>;
66
- }
67
-
68
- ```