bun-types 1.1.3 → 1.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 (3) hide show
  1. package/bun.d.ts +5 -0
  2. package/package.json +1 -1
  3. package/sqlite.d.ts +220 -3
package/bun.d.ts CHANGED
@@ -4326,6 +4326,11 @@ declare module "bun" {
4326
4326
  */
4327
4327
  windowsHide?: boolean;
4328
4328
 
4329
+ /**
4330
+ * If true, no quoting or escaping of arguments is done on Windows.
4331
+ */
4332
+ windowsVerbatimArguments?: boolean;
4333
+
4329
4334
  /**
4330
4335
  * Path to the executable to run in the subprocess. This defaults to `cmds[0]`.
4331
4336
  *
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "1.1.3",
2
+ "version": "1.1.4",
3
3
  "name": "bun-types",
4
4
  "license": "MIT",
5
5
  "main": "",
package/sqlite.d.ts CHANGED
@@ -24,7 +24,7 @@
24
24
  * | `null` | `NULL` |
25
25
  */
26
26
  declare module "bun:sqlite" {
27
- export class Database {
27
+ export class Database implements Disposable {
28
28
  /**
29
29
  * Open or create a SQLite3 database
30
30
  *
@@ -266,7 +266,20 @@ declare module "bun:sqlite" {
266
266
  *
267
267
  * Internally, this calls `sqlite3_close_v2`.
268
268
  */
269
- close(): void;
269
+ close(
270
+ /**
271
+ * If `true`, then the database will throw an error if it is in use
272
+ * @default false
273
+ *
274
+ * When true, this calls `sqlite3_close` instead of `sqlite3_close_v2`.
275
+ *
276
+ * Learn more about this in the [sqlite3 documentation](https://www.sqlite.org/c3ref/close.html).
277
+ *
278
+ * Bun will automatically call close by default when the database instance is garbage collected.
279
+ * In The future, Bun may default `throwOnError` to be true but for backwards compatibility, it is false by default.
280
+ */
281
+ throwOnError?: boolean,
282
+ ): void;
270
283
 
271
284
  /**
272
285
  * The filename passed when `new Database()` was called
@@ -313,6 +326,8 @@ declare module "bun:sqlite" {
313
326
  */
314
327
  static setCustomSQLite(path: string): boolean;
315
328
 
329
+ [Symbol.dispose](): void;
330
+
316
331
  /**
317
332
  * Creates a function that always runs inside a transaction. When the
318
333
  * function is invoked, it will begin a new transaction. When the function
@@ -439,6 +454,21 @@ declare module "bun:sqlite" {
439
454
  serialized: NodeJS.TypedArray | ArrayBufferLike,
440
455
  isReadOnly?: boolean,
441
456
  ): Database;
457
+
458
+ /**
459
+ * See `sqlite3_file_control` for more information.
460
+ * @link https://www.sqlite.org/c3ref/file_control.html
461
+ */
462
+ fileControl(op: number, arg?: ArrayBufferView | number): number;
463
+ /**
464
+ * See `sqlite3_file_control` for more information.
465
+ * @link https://www.sqlite.org/c3ref/file_control.html
466
+ */
467
+ fileControl(
468
+ zDbName: string,
469
+ op: number,
470
+ arg?: ArrayBufferView | number,
471
+ ): number;
442
472
  }
443
473
 
444
474
  /**
@@ -470,7 +500,8 @@ declare module "bun:sqlite" {
470
500
  export class Statement<
471
501
  ReturnType = unknown,
472
502
  ParamsType extends SQLQueryBindings[] = any[],
473
- > {
503
+ > implements Disposable
504
+ {
474
505
  /**
475
506
  * Creates a new prepared statement from native code.
476
507
  *
@@ -650,6 +681,11 @@ declare module "bun:sqlite" {
650
681
  */
651
682
  finalize(): void;
652
683
 
684
+ /**
685
+ * Calls {@link finalize} if it wasn't already called.
686
+ */
687
+ [Symbol.dispose](): void;
688
+
653
689
  /**
654
690
  * Return the expanded SQL string for the prepared statement.
655
691
  *
@@ -783,6 +819,187 @@ declare module "bun:sqlite" {
783
819
  * @constant 0x04
784
820
  */
785
821
  SQLITE_PREPARE_NO_VTAB: number;
822
+
823
+ /**
824
+ * @constant 1
825
+ */
826
+ SQLITE_FCNTL_LOCKSTATE: number;
827
+ /**
828
+ * @constant 2
829
+ */
830
+ SQLITE_FCNTL_GET_LOCKPROXYFILE: number;
831
+ /**
832
+ * @constant 3
833
+ */
834
+ SQLITE_FCNTL_SET_LOCKPROXYFILE: number;
835
+ /**
836
+ * @constant 4
837
+ */
838
+ SQLITE_FCNTL_LAST_ERRNO: number;
839
+ /**
840
+ * @constant 5
841
+ */
842
+ SQLITE_FCNTL_SIZE_HINT: number;
843
+ /**
844
+ * @constant 6
845
+ */
846
+ SQLITE_FCNTL_CHUNK_SIZE: number;
847
+ /**
848
+ * @constant 7
849
+ */
850
+ SQLITE_FCNTL_FILE_POINTER: number;
851
+ /**
852
+ * @constant 8
853
+ */
854
+ SQLITE_FCNTL_SYNC_OMITTED: number;
855
+ /**
856
+ * @constant 9
857
+ */
858
+ SQLITE_FCNTL_WIN32_AV_RETRY: number;
859
+ /**
860
+ * @constant 10
861
+ *
862
+ * Control whether or not the WAL is persisted
863
+ * Some versions of macOS configure WAL to be persistent by default.
864
+ *
865
+ * You can change this with code like the below:
866
+ * ```ts
867
+ * import { Database } from "bun:sqlite";
868
+ *
869
+ * const db = Database.open("mydb.sqlite");
870
+ * db.fileControl(constants.SQLITE_FCNTL_PERSIST_WAL, 0);
871
+ * // enable WAL
872
+ * db.exec("PRAGMA journal_mode = WAL");
873
+ * // .. do some work
874
+ * db.close();
875
+ * ```
876
+ *
877
+ */
878
+ SQLITE_FCNTL_PERSIST_WAL: number;
879
+ /**
880
+ * @constant 11
881
+ */
882
+ SQLITE_FCNTL_OVERWRITE: number;
883
+ /**
884
+ * @constant 12
885
+ */
886
+ SQLITE_FCNTL_VFSNAME: number;
887
+ /**
888
+ * @constant 13
889
+ */
890
+ SQLITE_FCNTL_POWERSAFE_OVERWRITE: number;
891
+ /**
892
+ * @constant 14
893
+ */
894
+ SQLITE_FCNTL_PRAGMA: number;
895
+ /**
896
+ * @constant 15
897
+ */
898
+ SQLITE_FCNTL_BUSYHANDLER: number;
899
+ /**
900
+ * @constant 16
901
+ */
902
+ SQLITE_FCNTL_TEMPFILENAME: number;
903
+ /**
904
+ * @constant 18
905
+ */
906
+ SQLITE_FCNTL_MMAP_SIZE: number;
907
+ /**
908
+ * @constant 19
909
+ */
910
+ SQLITE_FCNTL_TRACE: number;
911
+ /**
912
+ * @constant 20
913
+ */
914
+ SQLITE_FCNTL_HAS_MOVED: number;
915
+ /**
916
+ * @constant 21
917
+ */
918
+ SQLITE_FCNTL_SYNC: number;
919
+ /**
920
+ * @constant 22
921
+ */
922
+ SQLITE_FCNTL_COMMIT_PHASETWO: number;
923
+ /**
924
+ * @constant 23
925
+ */
926
+ SQLITE_FCNTL_WIN32_SET_HANDLE: number;
927
+ /**
928
+ * @constant 24
929
+ */
930
+ SQLITE_FCNTL_WAL_BLOCK: number;
931
+ /**
932
+ * @constant 25
933
+ */
934
+ SQLITE_FCNTL_ZIPVFS: number;
935
+ /**
936
+ * @constant 26
937
+ */
938
+ SQLITE_FCNTL_RBU: number;
939
+ /**
940
+ * @constant 27
941
+ */
942
+ SQLITE_FCNTL_VFS_POINTER: number;
943
+ /**
944
+ * @constant 28
945
+ */
946
+ SQLITE_FCNTL_JOURNAL_POINTER: number;
947
+ /**
948
+ * @constant 29
949
+ */
950
+ SQLITE_FCNTL_WIN32_GET_HANDLE: number;
951
+ /**
952
+ * @constant 30
953
+ */
954
+ SQLITE_FCNTL_PDB: number;
955
+ /**
956
+ * @constant 31
957
+ */
958
+ SQLITE_FCNTL_BEGIN_ATOMIC_WRITE: number;
959
+ /**
960
+ * @constant 32
961
+ */
962
+ SQLITE_FCNTL_COMMIT_ATOMIC_WRITE: number;
963
+ /**
964
+ * @constant 33
965
+ */
966
+ SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE: number;
967
+ /**
968
+ * @constant 34
969
+ */
970
+ SQLITE_FCNTL_LOCK_TIMEOUT: number;
971
+ /**
972
+ * @constant 35
973
+ */
974
+ SQLITE_FCNTL_DATA_VERSION: number;
975
+ /**
976
+ * @constant 36
977
+ */
978
+ SQLITE_FCNTL_SIZE_LIMIT: number;
979
+ /**
980
+ * @constant 37
981
+ */
982
+ SQLITE_FCNTL_CKPT_DONE: number;
983
+ /**
984
+ * @constant 38
985
+ */
986
+ SQLITE_FCNTL_RESERVE_BYTES: number;
987
+ /**
988
+ * @constant 39
989
+ */
990
+ SQLITE_FCNTL_CKPT_START: number;
991
+ /**
992
+ * @constant 40
993
+ */
994
+ SQLITE_FCNTL_EXTERNAL_READER: number;
995
+ /**
996
+ * @constant 41
997
+ */
998
+ SQLITE_FCNTL_CKSM_FILE: number;
999
+ /**
1000
+ * @constant 42
1001
+ */
1002
+ SQLITE_FCNTL_RESET_CACHE: number;
786
1003
  };
787
1004
 
788
1005
  /**