@d4l/collect-lib 1.41.0 → 1.42.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.
- package/README.md +11 -10
- package/dist/index.d.mts +1 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js.map +1 -1
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -293,16 +293,17 @@ Update the types by running `yarn run readme:update`.
|
|
|
293
293
|
|
|
294
294
|
#### TaskFrequency
|
|
295
295
|
|
|
296
|
-
| Properties
|
|
297
|
-
|
|
|
298
|
-
| type
|
|
299
|
-
| start
|
|
300
|
-
| end
|
|
301
|
-
| factor
|
|
302
|
-
| editDuration
|
|
303
|
-
| skipFirst
|
|
304
|
-
| retainCTAs
|
|
305
|
-
| allowAddOnDemand
|
|
296
|
+
| Properties | Required | Type | Description |
|
|
297
|
+
| -------------------- | -------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
298
|
+
| type | true | [FrequencyType](#FrequencyType) | Defines how often and when a questionnaire is triggered/added for the survey |
|
|
299
|
+
| start | true | ISO 8601 date with timezone | Determines the global starting date of the survey. The time component is also used for when the events should be available on the day they become available. |
|
|
300
|
+
| end | false | ISO 8601 date with timezone | Determines the global ending date of the survey. |
|
|
301
|
+
| factor | false | integer | For `daily`, `weekly` and `monthly` this factor is used to manipulate the cycle length, e.g. `daily` with a factor of 7 makes it a survey that is repeated every week, but doesn't necessarily start on monday. |
|
|
302
|
+
| editDuration | false | ISO 8601 duration string | Enables editing events of this survey for the given duration. |
|
|
303
|
+
| skipFirst | false | boolean | Determines if the first iteration of the survey after subscription should be skipped. Skipping it means the questionnaire won't open in the middle of the window and instead at the start of the next full window. Defaults to `false`. |
|
|
304
|
+
| retainCTAs | false | number | Allows configuring that x amount of previous CTAs remain active on the todo screen. |
|
|
305
|
+
| allowAddOnDemand | false | boolean | If true allows the task to also be added at any point in time (on demand). |
|
|
306
|
+
| availabilityDuration | false | ISO 8601 duration string | How long each occurrence stays actionable after `start`. Currently honored for recurring tasks only, where it defines a per-window slot [windowStart, windowStart + availabilityDuration] and MUST be <= one window (factor x unit) so at most one slot is ever open. Omit for "available the whole window". |
|
|
306
307
|
|
|
307
308
|
#### SurveyScoring
|
|
308
309
|
|
package/dist/index.d.mts
CHANGED