fiftyone.pipeline.core 4.4.99 → 4.4.100

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.
@@ -1,4 +1,7 @@
1
1
  export = SequenceElement;
2
+ /**
3
+ * @typedef {import('./flowData')} FlowData
4
+ */
2
5
  /**
3
6
  * The SequenceElement stores session data regarding requests
4
7
  * for client side JavaScript from the JavaScript created by a
@@ -8,5 +11,20 @@ export = SequenceElement;
8
11
  **/
9
12
  declare class SequenceElement extends FlowElement {
10
13
  constructor(...args: any[]);
14
+ evidenceKeyFilter: BasicListEvidenceKeyFilter;
15
+ /**
16
+ * Internal process function for the sequence element
17
+ * Checks if there is a session id and sequence number set
18
+ * if there is it increments the sequence number for that session
19
+ * if not it initialises both
20
+ *
21
+ * @param {FlowData} flowData flowData with the evidence in it
22
+ */
23
+ processInternal(flowData: FlowData): void;
24
+ }
25
+ declare namespace SequenceElement {
26
+ export { FlowData };
11
27
  }
12
28
  import FlowElement = require("./flowElement.js");
29
+ import BasicListEvidenceKeyFilter = require("./basicListEvidenceKeyFilter");
30
+ type FlowData = import("./flowData");
@@ -10,11 +10,18 @@ export = SetHeadersElement;
10
10
  */
11
11
  declare class SetHeadersElement extends FlowElement {
12
12
  constructor(...args: any[]);
13
+ properties: {
14
+ responseheadersdictionary: {
15
+ name: string;
16
+ type: string;
17
+ };
18
+ };
13
19
  headers: object;
14
20
  /**
15
21
  * Get the name of the header which the property relates to.
16
- * @param {string} propertyName: To get the header name from.
17
- * @return {string} Header name.
22
+ *
23
+ * @param {string} propertyName To get the header name from.
24
+ * @returns {string} Header name.
18
25
  */
19
26
  getHeaderName(propertyName: string): string;
20
27
  /**
@@ -27,15 +34,23 @@ declare class SetHeadersElement extends FlowElement {
27
34
  * [ 'device.SetHeaderBrowserAccept-CH',
28
35
  * 'device.SetHeaderPlatformAccept-CH',
29
36
  * 'device.SetHeaderHardwareAccept-CH' ] } }
30
- * @param {Pipeline} pipeline: The pipeline instance to get the properties from.
31
- * @return {object} Collection of headers which can be set in the response.
37
+ *
38
+ * @param {Pipeline} pipeline The pipeline instance to get the properties from.
39
+ * @returns {object} Collection of headers which can be set in the response.
32
40
  */
33
41
  constructHeaders(pipeline: Pipeline): object;
42
+ /**
43
+ * Add the response header dictionary to the FlowData.
44
+ *
45
+ * @param {FlowData} flowData the FlowData being processed
46
+ */
47
+ processInternal(flowData: FlowData): void;
34
48
  /**
35
49
  * Get response headers (e.g. Accept-CH)
36
- * @param {FlowData} flowData: A processed FlowData instance to get the response header values
50
+ *
51
+ * @param {FlowData} flowData A processed FlowData instance to get the response header values
37
52
  * from.
38
- * @return {object} A dictionary of response header names with their values if they are not
53
+ * @returns {object} A dictionary of response header names with their values if they are not
39
54
  * null
40
55
  */
41
56
  getResponseHeaders(flowData: FlowData): object;
@@ -43,10 +58,11 @@ declare class SetHeadersElement extends FlowElement {
43
58
  * Try to get the value for the given element and property.
44
59
  * If the value cannot be found or is null/unknown, then undefined
45
60
  * is returned.
46
- * @param {FlowData} flowData: A processed FlowData instance to get the value from.
47
- * @param {string} elementKey: Key for the element data to get the value from.
48
- * @param {string} propertyKey: Name of the property to get the value for.
49
- * @return {string | undefined} value string or undefined.
61
+ *
62
+ * @param {FlowData} flowData A processed FlowData instance to get the value from.
63
+ * @param {string} elementKey Key for the element data to get the value from.
64
+ * @param {string} propertyKey Name of the property to get the value for.
65
+ * @returns {string | undefined} value string or undefined.
50
66
  */
51
67
  tryGetValue(flowData: FlowData, elementKey: string, propertyKey: string): string | undefined;
52
68
  }
@@ -54,5 +70,5 @@ declare namespace SetHeadersElement {
54
70
  export { Pipeline, FlowData };
55
71
  }
56
72
  import FlowElement = require("./flowElement.js");
57
- type Pipeline = import('./pipeline');
58
- type FlowData = import('./flowData');
73
+ type Pipeline = import("./pipeline");
74
+ type FlowData = import("./flowData");