@crawlee/fs-storage-native 0.1.3 → 0.1.4

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 (4) hide show
  1. package/index.d.ts +42 -78
  2. package/index.js +555 -729
  3. package/lib.js +11 -15
  4. package/package.json +14 -7
package/index.d.ts CHANGED
@@ -74,94 +74,58 @@ export interface AddRequestsResponse {
74
74
  unprocessedRequests: UnprocessedRequest[];
75
75
  }
76
76
  export declare class DatasetItemIterator {
77
- /** Fetch the next item. Returns null when iteration is exhausted. */
78
- next(): Promise<Record<string, unknown> | null>;
77
+ /** Fetch the next item. Returns null when iteration is exhausted. */
78
+ next(): Promise<Record<string, unknown> | null>
79
79
  }
80
80
 
81
81
  export declare class FileSystemDatasetClient {
82
- static open(
83
- id?: string | undefined | null,
84
- name?: string | undefined | null,
85
- alias?: string | undefined | null,
86
- storageDir?: string | undefined | null,
87
- ): Promise<FileSystemDatasetClient>;
88
- get pathToDataset(): string;
89
- get pathToMetadata(): string;
90
- getMetadata(): Promise<DatasetMetadata>;
91
- dropStorage(): Promise<void>;
92
- purge(): Promise<void>;
93
- pushData(data: Record<string, unknown> | Record<string, unknown>[]): Promise<void>;
94
- getData(
95
- offset?: number | undefined | null,
96
- limit?: number | undefined | null,
97
- desc?: boolean | undefined | null,
98
- skipEmpty?: boolean | undefined | null,
99
- ): Promise<DatasetItemsListPage>;
100
- iterateItems(
101
- offset?: number | undefined | null,
102
- limit?: number | undefined | null,
103
- desc?: boolean | undefined | null,
104
- skipEmpty?: boolean | undefined | null,
105
- pageSize?: number | undefined | null,
106
- ): Promise<DatasetItemIterator>;
82
+ static open(id?: string | undefined | null, name?: string | undefined | null, alias?: string | undefined | null, storageDir?: string | undefined | null): Promise<FileSystemDatasetClient>
83
+ get pathToDataset(): string
84
+ get pathToMetadata(): string
85
+ getMetadata(): Promise<DatasetMetadata>
86
+ dropStorage(): Promise<void>
87
+ purge(): Promise<void>
88
+ pushData(data: Record<string, unknown> | Record<string, unknown>[]): Promise<void>
89
+ getData(offset?: number | undefined | null, limit?: number | undefined | null, desc?: boolean | undefined | null, skipEmpty?: boolean | undefined | null): Promise<DatasetItemsListPage>
90
+ iterateItems(offset?: number | undefined | null, limit?: number | undefined | null, desc?: boolean | undefined | null, skipEmpty?: boolean | undefined | null, pageSize?: number | undefined | null): Promise<DatasetItemIterator>
107
91
  }
108
92
 
109
93
  export declare class FileSystemKeyValueStoreClient {
110
- static open(
111
- id?: string | undefined | null,
112
- name?: string | undefined | null,
113
- alias?: string | undefined | null,
114
- storageDir?: string | undefined | null,
115
- ): Promise<FileSystemKeyValueStoreClient>;
116
- get pathToKvs(): string;
117
- get pathToMetadata(): string;
118
- getMetadata(): Promise<KeyValueStoreMetadata>;
119
- dropStorage(): Promise<void>;
120
- purge(): Promise<void>;
121
- /** Get a record by key. Returns the raw value bytes as a Buffer. */
122
- getValue(key: string): Promise<KeyValueStoreRecord | null>;
123
- /** Set a value from a Buffer. */
124
- setValue(key: string, value: Buffer, contentType?: string | undefined | null): Promise<void>;
125
- deleteValue(key: string): Promise<void>;
126
- iterateKeys(
127
- exclusiveStartKey?: string | undefined | null,
128
- limit?: number | undefined | null,
129
- pageSize?: number | undefined | null,
130
- ): Promise<KvsKeyIterator>;
131
- getPublicUrl(key: string): Promise<string>;
132
- recordExists(key: string): Promise<boolean>;
94
+ static open(id?: string | undefined | null, name?: string | undefined | null, alias?: string | undefined | null, storageDir?: string | undefined | null): Promise<FileSystemKeyValueStoreClient>
95
+ get pathToKvs(): string
96
+ get pathToMetadata(): string
97
+ getMetadata(): Promise<KeyValueStoreMetadata>
98
+ dropStorage(): Promise<void>
99
+ purge(): Promise<void>
100
+ /** Get a record by key. Returns the raw value bytes as a Buffer. */
101
+ getValue(key: string): Promise<KeyValueStoreRecord | null>
102
+ /** Set a value from a Buffer. */
103
+ setValue(key: string, value: Buffer, contentType?: string | undefined | null): Promise<void>
104
+ deleteValue(key: string): Promise<void>
105
+ iterateKeys(exclusiveStartKey?: string | undefined | null, limit?: number | undefined | null, pageSize?: number | undefined | null): Promise<KvsKeyIterator>
106
+ getPublicUrl(key: string): Promise<string>
107
+ recordExists(key: string): Promise<boolean>
133
108
  }
134
109
 
135
110
  export declare class FileSystemRequestQueueClient {
136
- static open(
137
- id?: string | undefined | null,
138
- name?: string | undefined | null,
139
- alias?: string | undefined | null,
140
- storageDir?: string | undefined | null,
141
- ): Promise<FileSystemRequestQueueClient>;
142
- get pathToRq(): string;
143
- get pathToMetadata(): string;
144
- getMetadata(): Promise<RequestQueueMetadata>;
145
- dropStorage(): Promise<void>;
146
- purge(): Promise<void>;
147
- addBatchOfRequests(
148
- requests: Record<string, unknown>[],
149
- forefront?: boolean | undefined | null,
150
- ): Promise<AddRequestsResponse>;
151
- getRequest(uniqueKey: string): Promise<Record<string, unknown> | null>;
152
- fetchNextRequest(): Promise<Record<string, unknown> | null>;
153
- markRequestAsHandled(request: Record<string, unknown>): Promise<ProcessedRequest | null>;
154
- reclaimRequest(
155
- request: Record<string, unknown>,
156
- forefront?: boolean | undefined | null,
157
- ): Promise<ProcessedRequest | null>;
158
- isEmpty(): Promise<boolean>;
159
- isFinished(): Promise<boolean>;
160
- setExpectedRequestProcessingTime(secs: number): Promise<void>;
161
- persistState(): Promise<void>;
111
+ static open(id?: string | undefined | null, name?: string | undefined | null, alias?: string | undefined | null, storageDir?: string | undefined | null): Promise<FileSystemRequestQueueClient>
112
+ get pathToRq(): string
113
+ get pathToMetadata(): string
114
+ getMetadata(): Promise<RequestQueueMetadata>
115
+ dropStorage(): Promise<void>
116
+ purge(): Promise<void>
117
+ addBatchOfRequests(requests: Record<string, unknown>[], forefront?: boolean | undefined | null): Promise<AddRequestsResponse>
118
+ getRequest(uniqueKey: string): Promise<Record<string, unknown> | null>
119
+ fetchNextRequest(): Promise<Record<string, unknown> | null>
120
+ markRequestAsHandled(request: Record<string, unknown>): Promise<ProcessedRequest | null>
121
+ reclaimRequest(request: Record<string, unknown>, forefront?: boolean | undefined | null): Promise<ProcessedRequest | null>
122
+ isEmpty(): Promise<boolean>
123
+ isFinished(): Promise<boolean>
124
+ setExpectedRequestProcessingTime(secs: number): Promise<void>
125
+ persistState(): Promise<void>
162
126
  }
163
127
 
164
128
  export declare class KvsKeyIterator {
165
- /** Fetch the next key metadata entry. Returns null when iteration is exhausted. */
166
- next(): Promise<KeyValueStoreRecordMetadata | null>;
129
+ /** Fetch the next key metadata entry. Returns null when iteration is exhausted. */
130
+ next(): Promise<KeyValueStoreRecordMetadata | null>
167
131
  }