@effect/platform 0.72.2 → 0.73.1

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 (65) hide show
  1. package/README.md +637 -0
  2. package/Url/package.json +6 -0
  3. package/dist/cjs/HttpApi.js.map +1 -1
  4. package/dist/cjs/HttpApiEndpoint.js.map +1 -1
  5. package/dist/cjs/HttpApiGroup.js.map +1 -1
  6. package/dist/cjs/HttpClient.js +8 -1
  7. package/dist/cjs/HttpClient.js.map +1 -1
  8. package/dist/cjs/HttpMethod.js +24 -1
  9. package/dist/cjs/HttpMethod.js.map +1 -1
  10. package/dist/cjs/OpenApi.js +82 -42
  11. package/dist/cjs/OpenApi.js.map +1 -1
  12. package/dist/cjs/Runtime.js.map +1 -1
  13. package/dist/cjs/Url.js +259 -0
  14. package/dist/cjs/Url.js.map +1 -0
  15. package/dist/cjs/index.js +3 -1
  16. package/dist/cjs/internal/httpClient.js +3 -1
  17. package/dist/cjs/internal/httpClient.js.map +1 -1
  18. package/dist/dts/HttpApi.d.ts +1 -2
  19. package/dist/dts/HttpApi.d.ts.map +1 -1
  20. package/dist/dts/HttpApiBuilder.d.ts +1 -1
  21. package/dist/dts/HttpApiBuilder.d.ts.map +1 -1
  22. package/dist/dts/HttpApiEndpoint.d.ts +16 -8
  23. package/dist/dts/HttpApiEndpoint.d.ts.map +1 -1
  24. package/dist/dts/HttpApiGroup.d.ts +1 -2
  25. package/dist/dts/HttpApiGroup.d.ts.map +1 -1
  26. package/dist/dts/HttpClient.d.ts +22 -0
  27. package/dist/dts/HttpClient.d.ts.map +1 -1
  28. package/dist/dts/HttpMethod.d.ts +22 -0
  29. package/dist/dts/HttpMethod.d.ts.map +1 -1
  30. package/dist/dts/OpenApi.d.ts +100 -110
  31. package/dist/dts/OpenApi.d.ts.map +1 -1
  32. package/dist/dts/Runtime.d.ts +48 -0
  33. package/dist/dts/Runtime.d.ts.map +1 -1
  34. package/dist/dts/Url.d.ts +591 -0
  35. package/dist/dts/Url.d.ts.map +1 -0
  36. package/dist/dts/index.d.ts +4 -0
  37. package/dist/dts/index.d.ts.map +1 -1
  38. package/dist/esm/HttpApi.js.map +1 -1
  39. package/dist/esm/HttpApiEndpoint.js.map +1 -1
  40. package/dist/esm/HttpApiGroup.js.map +1 -1
  41. package/dist/esm/HttpClient.js +7 -0
  42. package/dist/esm/HttpClient.js.map +1 -1
  43. package/dist/esm/HttpMethod.js +22 -0
  44. package/dist/esm/HttpMethod.js.map +1 -1
  45. package/dist/esm/OpenApi.js +82 -41
  46. package/dist/esm/OpenApi.js.map +1 -1
  47. package/dist/esm/Runtime.js.map +1 -1
  48. package/dist/esm/Url.js +248 -0
  49. package/dist/esm/Url.js.map +1 -0
  50. package/dist/esm/index.js +4 -0
  51. package/dist/esm/index.js.map +1 -1
  52. package/dist/esm/internal/httpClient.js +2 -0
  53. package/dist/esm/internal/httpClient.js.map +1 -1
  54. package/package.json +10 -2
  55. package/src/HttpApi.ts +2 -3
  56. package/src/HttpApiBuilder.ts +1 -1
  57. package/src/HttpApiEndpoint.ts +22 -13
  58. package/src/HttpApiGroup.ts +2 -3
  59. package/src/HttpClient.ts +28 -0
  60. package/src/HttpMethod.ts +24 -0
  61. package/src/OpenApi.ts +174 -181
  62. package/src/Runtime.ts +48 -0
  63. package/src/Url.ts +632 -0
  64. package/src/index.ts +5 -0
  65. package/src/internal/httpClient.ts +11 -0
@@ -1 +1 @@
1
- {"version":3,"file":"OpenApi.d.ts","sourceRoot":"","sources":["../../src/OpenApi.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AAIzC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAInD,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAKvC,OAAO,KAAK,UAAU,MAAM,wBAAwB,CAAA;;AAEpD;;;GAGG;AACH,qBAAa,UAAW,SAAQ,eAAwE;CAAG;;AAE3G;;;GAGG;AACH,qBAAa,KAAM,SAAQ,UAA8D;CAAG;;AAE5F;;;GAGG;AACH,qBAAa,OAAQ,SAAQ,YAAkE;CAAG;;AAElG;;;GAGG;AACH,qBAAa,WAAY,SAAQ,gBAA0E;CAAG;;AAE9G;;;GAGG;AACH,qBAAa,OAAQ,SAAQ,YAA8E;CAAG;;AAE9G;;;GAGG;AACH,qBAAa,YACX,SAAQ,iBAA6F;CACrG;;AAEF;;;GAGG;AACH,qBAAa,OACX,SAAQ,YAA4F;CACpG;;AAEF;;;GAGG;AACH,qBAAa,MAAO,SAAQ,WAAgE;CAAG;;AAE/F;;;GAGG;AACH,qBAAa,OAAQ,SAAQ,YAAkE;CAAG;;AAElG;;;GAGG;AACH,qBAAa,UAAW,SAAQ,eAAyE;CAAG;;AAE5G;;;GAGG;AACH,qBAAa,QAAS,SAAQ,aAAqF;CAAG;;AAEtH;;;GAGG;AACH,qBAAa,OAAQ,SAAQ,YAE3B;CAAG;8GASW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;AAP3D;;;;GAIG;AACH,qBAAa,SAAU,SAAQ,cAG5B;CAAG;AAmBN;;;GAGG;AACH,eAAO,MAAM,WAAW,EAAE,CACxB,OAAO,EAAE;IACP,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACxC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACnC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACrC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACzC,QAAQ,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,SAAS,CAAA;IACjD,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACrC,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACzC,QAAQ,CAAC,YAAY,CAAC,EAAE,uBAAuB,GAAG,SAAS,CAAA;IAC3D,QAAQ,CAAC,OAAO,CAAC,EAAE,aAAa,CAAC,iBAAiB,CAAC,GAAG,SAAS,CAAA;IAC/D,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACpC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IACvD,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACtC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,GAAG,SAAS,CAAA;CAC7F,KACE,OAAO,CAAC,OAAO,CAAC,KAAK,CAcxB,CAAA;AAIF;;;GAGG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,SAAS,OAAO,CAAC,OAAO,CAAC,GAAG,QAAQ,CAAC,KAAG,WAkNhE,CAAA;AAsCD;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAA;IAC9B,QAAQ,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAA;IAC3C,QAAQ,CAAC,KAAK,EAAE,gBAAgB,CAAA;IAChC,QAAQ,CAAC,UAAU,CAAC,EAAE,iBAAiB,CAAA;IACvC,QAAQ,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAA;IACrD,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,CAAA;IACrC,QAAQ,CAAC,YAAY,CAAC,EAAE,uBAAuB,CAAA;CAChD;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAC7B,QAAQ,CAAC,OAAO,CAAC,EAAE,kBAAkB,CAAA;IACrC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAC7B,QAAQ,CAAC,YAAY,CAAC,EAAE,uBAAuB,CAAA;CAChD;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAC7B,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAAA;CAC/D;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAA;IAC1C,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAC9B;AAED;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,cAAc,CAC3C,MAAM,EACN,mBAAmB,CACpB,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAC7B,KAAK,GACL,KAAK,GACL,MAAM,GACN,QAAQ,GACR,SAAS,GACT,MAAM,GACN,OAAO,GACP,OAAO,CAAA;AAEX;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAC3B;IACA,QAAQ,EAAE,CAAC,IAAI,qBAAqB,CAAC,CAAC,EAAE,oBAAoB;CAC7D,GACC;IACA,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAC7B,QAAQ,CAAC,UAAU,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAA;CAClD,CAAA;AAEH;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,EAAE,EAAE,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAA;IACnD,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,UAAU,CAAA;IACtC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAC7B,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;IAC3B,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAA;IAC7B,QAAQ,CAAC,eAAe,CAAC,EAAE,OAAO,CAAA;CACnC;AAED;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAA;AAEtE;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAC9B,kBAAkB,GAClB,iBAAiB,GACjB,mCAAmC,GACnC,qBAAqB,GACrB,YAAY,CAAA;AAEhB;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,QAAQ,EAAE,CAAC,IAAI,sBAAsB,CAAC,CAAC,EAAE,oBAAoB;CAC9D,CAAA;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAC7B,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,UAAU,CAAA;CACvC;AAED;;;GAGG;AACH,MAAM,MAAM,0BAA0B,GAAG,cAAc,CACrD,MAAM,EACN,yBAAyB,CAC1B,CAAA;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,OAAO,CAAC,EAAE,kBAAkB,CAAA;IACrC,QAAQ,CAAC,OAAO,CAAC,EAAE,0BAA0B,CAAA;IAC7C,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,UAAU,CAAA;IACvC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,OAAO,EAAE,kBAAkB,CAAA;IACpC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAC7B,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,CAAC,MAAM,EAAE,UAAU,CAAC,UAAU,CAAC,CAAA;IAChE,QAAQ,CAAC,eAAe,CAAC,EAAE,cAAc,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAA;CACzE;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAC7B,QAAQ,CAAC,MAAM,EAAE,QAAQ,GAAG,OAAO,GAAG,MAAM,CAAA;IAE5C,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAA;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;IACvB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,EAAE,EAAE,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAA;CAC3C;AAED;;;GAGG;AACH,MAAM,WAAW,8BAA8B;IAC7C,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAA;IAC1B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;IACvB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAC7B,QAAQ,CAAC,KAAK,EAAE,cAAc,CAC5B,UAAU,GAAG,UAAU,GAAG,mBAAmB,GAAG,mBAAmB,EACnE,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,CAChC,CAAA;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,kCAAkC;IACjD,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAA;IAC9B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAC7B,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAA;CAClC;AAED;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAC7B,yBAAyB,GACzB,2BAA2B,GAC3B,8BAA8B,GAC9B,2BAA2B,GAC3B,kCAAkC,CAAA;AAEtC;;;GAGG;AACH,MAAM,MAAM,0BAA0B,GAAG,cAAc,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAA;AAE9E;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,WAAW,CAAC,EAAE,sBAAsB,CAAA;IAC7C,QAAQ,CAAC,SAAS,CAAC,EAAE,oBAAoB,CAAA;IACzC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAC7B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAC7B,QAAQ,CAAC,UAAU,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAA;IACjD,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAA;IAC7B,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;IAC7B,QAAQ,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAA;IACrD,QAAQ,CAAC,YAAY,CAAC,EAAE,uBAAuB,CAAA;CAChD"}
1
+ {"version":3,"file":"OpenApi.d.ts","sourceRoot":"","sources":["../../src/OpenApi.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AACjD,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AAMzC,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AACvC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAKrD,OAAO,KAAK,UAAU,MAAM,wBAAwB,CAAA;;AAEpD;;;GAGG;AACH,qBAAa,UAAW,SAAQ,eAAwE;CAAG;;AAE3G;;;GAGG;AACH,qBAAa,KAAM,SAAQ,UAA8D;CAAG;;AAE5F;;;GAGG;AACH,qBAAa,OAAQ,SAAQ,YAAkE;CAAG;;AAElG;;;GAGG;AACH,qBAAa,WAAY,SAAQ,gBAA0E;CAAG;;AAE9G;;;GAGG;AACH,qBAAa,OAAQ,SAAQ,YAA8E;CAAG;;AAE9G;;;GAGG;AACH,qBAAa,YACX,SAAQ,iBAA6F;CACrG;;AAEF;;;GAGG;AACH,qBAAa,OACX,SAAQ,YAA4F;CACpG;;AAEF;;;GAGG;AACH,qBAAa,MAAO,SAAQ,WAAgE;CAAG;;AAE/F;;;GAGG;AACH,qBAAa,OAAQ,SAAQ,YAAkE;CAAG;;AAElG;;;GAGG;AACH,qBAAa,UAAW,SAAQ,eAAyE;CAAG;;AAE5G;;;GAGG;AACH,qBAAa,QAAS,SAAQ,aAAqF;CAAG;;AAEtH;;;GAGG;AACH,qBAAa,OAAQ,SAAQ,YAE3B;CAAG;8GASW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;AAP3D;;;;GAIG;AACH,qBAAa,SAAU,SAAQ,cAG5B;CAAG;AAmBN;;;GAGG;AACH,eAAO,MAAM,WAAW,EAAE,CACxB,OAAO,EAAE;IACP,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACxC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACnC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACrC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACzC,QAAQ,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,SAAS,CAAA;IACjD,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACrC,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACzC,QAAQ,CAAC,YAAY,CAAC,EAAE,uBAAuB,GAAG,SAAS,CAAA;IAC3D,QAAQ,CAAC,OAAO,CAAC,EAAE,aAAa,CAAC,iBAAiB,CAAC,GAAG,SAAS,CAAA;IAC/D,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACpC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IACvD,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACtC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,GAAG,SAAS,CAAA;CAC7F,KACE,OAAO,CAAC,OAAO,CAAC,KAAK,CAcxB,CAAA;AAoBF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,eAAO,MAAM,OAAO,GAAI,EAAE,SAAS,MAAM,EAAE,MAAM,SAAS,YAAY,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,OACzE,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,KACrC,WAuNF,CAAA;AAsCD;;;;;;;GAOG;AACH,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,OAAO,CAAA;IAChB,IAAI,EAAE,eAAe,CAAA;IACrB,KAAK,EAAE,gBAAgB,CAAA;IACvB,UAAU,EAAE,iBAAiB,CAAA;IAC7B,QAAQ,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAA;IAC3C,IAAI,EAAE,KAAK,CAAC,cAAc,CAAC,CAAA;IAC3B,OAAO,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAA;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,kBAAkB,CAAA;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,YAAY,CAAC,EAAE,uBAAuB,CAAA;CACvC;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,GAAG,EAAE,MAAM,CAAA;IACX,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,MAAM,CAAA;IACX,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAAA;CACtD;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAA;AAElE;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAC7B,KAAK,GACL,KAAK,GACL,MAAM,GACN,QAAQ,GACR,SAAS,GACT,MAAM,GACN,OAAO,GACP,OAAO,CAAA;AAEX;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG;KAC/B,CAAC,IAAI,qBAAqB,CAAC,CAAC,EAAE,oBAAoB;CACpD,CAAA;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAA;IAC1C,MAAM,EAAE,UAAU,CAAC,UAAU,CAAA;IAC7B,QAAQ,EAAE,OAAO,CAAA;IACjB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAA;AAEtE;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAC9B,kBAAkB,GAClB,iBAAiB,GACjB,mCAAmC,GACnC,qBAAqB,GACrB,YAAY,CAAA;AAEhB;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG;KAC9B,CAAC,IAAI,sBAAsB,CAAC,CAAC,EAAE,oBAAoB;CACrD,CAAA;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,kBAAkB,CAAA;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,UAAU,CAAC,UAAU,CAAA;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,kBAAkB,CAAA;IAC3B,QAAQ,EAAE,IAAI,CAAA;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,UAAU,CAAC,CAAA;IAC9C,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAA;CACvD;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,MAAM,EAAE,QAAQ,GAAG,OAAO,GAAG,MAAM,CAAA;IACnC,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;IACvB,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAA;IACjC,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAC7B,yBAAyB,GACzB,2BAA2B,CAAA;AAE/B;;;GAGG;AACH,MAAM,MAAM,0BAA0B,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAA;AAEtE;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAA;IACvC,SAAS,EAAE,oBAAoB,CAAA;IAC/B,4EAA4E;IAC5E,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;IAC3B,QAAQ,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAA;IAC3C,WAAW,CAAC,EAAE,sBAAsB,CAAA;IACpC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,YAAY,CAAC,EAAE,uBAAuB,CAAA;CACvC"}
@@ -18,11 +18,59 @@ export declare const defaultTeardown: Teardown;
18
18
  * @since 1.0.0
19
19
  */
20
20
  export interface RunMain {
21
+ /**
22
+ * Helps you run a main effect with built-in error handling, logging, and signal management.
23
+ *
24
+ * **Details**
25
+ *
26
+ * This function launches an Effect as the main entry point, setting exit codes
27
+ * based on success or failure, handling interrupts (e.g., Ctrl+C), and optionally
28
+ * logging errors. By default, it logs errors and uses a "pretty" format, but both
29
+ * behaviors can be turned off. You can also provide custom teardown logic to
30
+ * finalize resources or produce different exit codes.
31
+ *
32
+ * **Options**
33
+ *
34
+ * An optional object that can include:
35
+ * - `disableErrorReporting`: Turn off automatic error logging.
36
+ * - `disablePrettyLogger`: Avoid adding the pretty logger.
37
+ * - `teardown`: Provide custom finalization logic.
38
+ *
39
+ * **When to Use**
40
+ *
41
+ * Use this function to run an Effect as your application’s main program, especially
42
+ * when you need structured error handling, log management, interrupt support,
43
+ * or advanced teardown capabilities.
44
+ */
21
45
  (options?: {
22
46
  readonly disableErrorReporting?: boolean | undefined;
23
47
  readonly disablePrettyLogger?: boolean | undefined;
24
48
  readonly teardown?: Teardown | undefined;
25
49
  }): <E, A>(effect: Effect.Effect<A, E>) => void;
50
+ /**
51
+ * Helps you run a main effect with built-in error handling, logging, and signal management.
52
+ *
53
+ * **Details**
54
+ *
55
+ * This function launches an Effect as the main entry point, setting exit codes
56
+ * based on success or failure, handling interrupts (e.g., Ctrl+C), and optionally
57
+ * logging errors. By default, it logs errors and uses a "pretty" format, but both
58
+ * behaviors can be turned off. You can also provide custom teardown logic to
59
+ * finalize resources or produce different exit codes.
60
+ *
61
+ * **Options**
62
+ *
63
+ * An optional object that can include:
64
+ * - `disableErrorReporting`: Turn off automatic error logging.
65
+ * - `disablePrettyLogger`: Avoid adding the pretty logger.
66
+ * - `teardown`: Provide custom finalization logic.
67
+ *
68
+ * **When to Use**
69
+ *
70
+ * Use this function to run an Effect as your application’s main program, especially
71
+ * when you need structured error handling, log management, interrupt support,
72
+ * or advanced teardown capabilities.
73
+ */
26
74
  <E, A>(effect: Effect.Effect<A, E>, options?: {
27
75
  readonly disableErrorReporting?: boolean | undefined;
28
76
  readonly disablePrettyLogger?: boolean | undefined;
@@ -1 +1 @@
1
- {"version":3,"file":"Runtime.d.ts","sourceRoot":"","sources":["../../src/Runtime.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,KAAK,IAAI,MAAM,aAAa,CAAA;AACnC,OAAO,KAAK,KAAK,KAAK,MAAM,cAAc,CAAA;AAQ1C;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI,CAAA;CACpE;AAED;;;GAGG;AACH,eAAO,MAAM,eAAe,EAAE,QAK7B,CAAA;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB,CACE,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QACpD,QAAQ,CAAC,mBAAmB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QAClD,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;KACzC,GACA,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,CAAA;IAC9C,CAAC,CAAC,EAAE,CAAC,EACH,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAC3B,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QACpD,QAAQ,CAAC,mBAAmB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QAClD,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;KACzC,GACA,IAAI,CAAA;CACR;AAiBD;;;GAGG;AACH,eAAO,MAAM,WAAW,MACnB,CAAC,CAAC,EAAE,CAAC,EACN,OAAO,EAAE;IACP,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IACxC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;CAC5B,KACE,IAAI,KACR,OAuBC,CAAA"}
1
+ {"version":3,"file":"Runtime.d.ts","sourceRoot":"","sources":["../../src/Runtime.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,KAAK,IAAI,MAAM,aAAa,CAAA;AACnC,OAAO,KAAK,KAAK,KAAK,MAAM,cAAc,CAAA;AAQ1C;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI,CAAA;CACpE;AAED;;;GAGG;AACH,eAAO,MAAM,eAAe,EAAE,QAK7B,CAAA;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,CACE,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QACpD,QAAQ,CAAC,mBAAmB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QAClD,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;KACzC,GACA,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,CAAA;IAC9C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,CAAC,CAAC,EAAE,CAAC,EACH,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAC3B,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QACpD,QAAQ,CAAC,mBAAmB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QAClD,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;KACzC,GACA,IAAI,CAAA;CACR;AAiBD;;;GAGG;AACH,eAAO,MAAM,WAAW,MACnB,CAAC,CAAC,EAAE,CAAC,EACN,OAAO,EAAE;IACP,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IACxC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;CAC5B,KACE,IAAI,KACR,OAuBC,CAAA"}
@@ -0,0 +1,591 @@
1
+ /**
2
+ * @since 1.0.0
3
+ */
4
+ import * as Cause from "effect/Cause";
5
+ import * as Either from "effect/Either";
6
+ import * as UrlParams from "./UrlParams.js";
7
+ /**
8
+ * Parses a URL string into a `URL` object, returning an `Either` type for safe
9
+ * error handling.
10
+ *
11
+ * **Details**
12
+ *
13
+ * This function converts a string into a `URL` object, enabling safe URL
14
+ * parsing with built-in error handling. If the string is invalid or fails to
15
+ * parse, this function does not throw an error; instead, it wraps the error in
16
+ * a `IllegalArgumentException` and returns it as the `Left` value of an
17
+ * `Either`. The `Right` value contains the successfully parsed `URL`.
18
+ *
19
+ * An optional `base` parameter can be provided to resolve relative URLs. If
20
+ * specified, the function interprets the input `url` as relative to this
21
+ * `base`. This is especially useful when dealing with URLs that might not be
22
+ * fully qualified.
23
+ *
24
+ * @example
25
+ * ```ts
26
+ * import { Url } from "@effect/platform"
27
+ * import { Either } from "effect"
28
+ *
29
+ * // Parse an absolute URL
30
+ * //
31
+ * // ┌─── Either<URL, IllegalArgumentException>
32
+ * // ▼
33
+ * const parsed = Url.fromString("https://example.com/path")
34
+ *
35
+ * if (Either.isRight(parsed)) {
36
+ * console.log("Parsed URL:", parsed.right.toString())
37
+ * } else {
38
+ * console.log("Error:", parsed.left.message)
39
+ * }
40
+ * // Output: Parsed URL: https://example.com/path
41
+ *
42
+ * // Parse a relative URL with a base
43
+ * const relativeParsed = Url.fromString("/relative-path", "https://example.com")
44
+ *
45
+ * if (Either.isRight(relativeParsed)) {
46
+ * console.log("Parsed relative URL:", relativeParsed.right.toString())
47
+ * } else {
48
+ * console.log("Error:", relativeParsed.left.message)
49
+ * }
50
+ * // Output: Parsed relative URL: https://example.com/relative-path
51
+ * ```
52
+ *
53
+ * @since 1.0.0
54
+ * @category Constructors
55
+ */
56
+ export declare const fromString: {
57
+ /**
58
+ * Parses a URL string into a `URL` object, returning an `Either` type for safe
59
+ * error handling.
60
+ *
61
+ * **Details**
62
+ *
63
+ * This function converts a string into a `URL` object, enabling safe URL
64
+ * parsing with built-in error handling. If the string is invalid or fails to
65
+ * parse, this function does not throw an error; instead, it wraps the error in
66
+ * a `IllegalArgumentException` and returns it as the `Left` value of an
67
+ * `Either`. The `Right` value contains the successfully parsed `URL`.
68
+ *
69
+ * An optional `base` parameter can be provided to resolve relative URLs. If
70
+ * specified, the function interprets the input `url` as relative to this
71
+ * `base`. This is especially useful when dealing with URLs that might not be
72
+ * fully qualified.
73
+ *
74
+ * @example
75
+ * ```ts
76
+ * import { Url } from "@effect/platform"
77
+ * import { Either } from "effect"
78
+ *
79
+ * // Parse an absolute URL
80
+ * //
81
+ * // ┌─── Either<URL, IllegalArgumentException>
82
+ * // ▼
83
+ * const parsed = Url.fromString("https://example.com/path")
84
+ *
85
+ * if (Either.isRight(parsed)) {
86
+ * console.log("Parsed URL:", parsed.right.toString())
87
+ * } else {
88
+ * console.log("Error:", parsed.left.message)
89
+ * }
90
+ * // Output: Parsed URL: https://example.com/path
91
+ *
92
+ * // Parse a relative URL with a base
93
+ * const relativeParsed = Url.fromString("/relative-path", "https://example.com")
94
+ *
95
+ * if (Either.isRight(relativeParsed)) {
96
+ * console.log("Parsed relative URL:", relativeParsed.right.toString())
97
+ * } else {
98
+ * console.log("Error:", relativeParsed.left.message)
99
+ * }
100
+ * // Output: Parsed relative URL: https://example.com/relative-path
101
+ * ```
102
+ *
103
+ * @since 1.0.0
104
+ * @category Constructors
105
+ */
106
+ (url: string, base?: string | URL | undefined): Either.Either<URL, Cause.IllegalArgumentException>;
107
+ };
108
+ /**
109
+ * This function clones the original `URL` object and applies a callback to the
110
+ * clone, allowing multiple updates at once.
111
+ *
112
+ * @example
113
+ * ```ts
114
+ * import { Url } from "@effect/platform"
115
+ *
116
+ * const myUrl = new URL("https://example.com")
117
+ *
118
+ * const mutatedUrl = Url.mutate(myUrl, (url) => {
119
+ * url.username = "user"
120
+ * url.password = "pass"
121
+ * })
122
+ *
123
+ * console.log("Mutated:", mutatedUrl.toString())
124
+ * // Output: Mutated: https://user:pass@example.com/
125
+ * ```
126
+ *
127
+ * @since 1.0.0
128
+ * @category Modifiers
129
+ */
130
+ export declare const mutate: {
131
+ /**
132
+ * This function clones the original `URL` object and applies a callback to the
133
+ * clone, allowing multiple updates at once.
134
+ *
135
+ * @example
136
+ * ```ts
137
+ * import { Url } from "@effect/platform"
138
+ *
139
+ * const myUrl = new URL("https://example.com")
140
+ *
141
+ * const mutatedUrl = Url.mutate(myUrl, (url) => {
142
+ * url.username = "user"
143
+ * url.password = "pass"
144
+ * })
145
+ *
146
+ * console.log("Mutated:", mutatedUrl.toString())
147
+ * // Output: Mutated: https://user:pass@example.com/
148
+ * ```
149
+ *
150
+ * @since 1.0.0
151
+ * @category Modifiers
152
+ */
153
+ (f: (url: URL) => void): (self: URL) => URL;
154
+ /**
155
+ * This function clones the original `URL` object and applies a callback to the
156
+ * clone, allowing multiple updates at once.
157
+ *
158
+ * @example
159
+ * ```ts
160
+ * import { Url } from "@effect/platform"
161
+ *
162
+ * const myUrl = new URL("https://example.com")
163
+ *
164
+ * const mutatedUrl = Url.mutate(myUrl, (url) => {
165
+ * url.username = "user"
166
+ * url.password = "pass"
167
+ * })
168
+ *
169
+ * console.log("Mutated:", mutatedUrl.toString())
170
+ * // Output: Mutated: https://user:pass@example.com/
171
+ * ```
172
+ *
173
+ * @since 1.0.0
174
+ * @category Modifiers
175
+ */
176
+ (self: URL, f: (url: URL) => void): URL;
177
+ };
178
+ /**
179
+ * Updates the hash fragment of the URL.
180
+ *
181
+ * @since 1.0.0
182
+ * @category Setters
183
+ */
184
+ export declare const setHash: {
185
+ /**
186
+ * Updates the hash fragment of the URL.
187
+ *
188
+ * @since 1.0.0
189
+ * @category Setters
190
+ */
191
+ (hash: string): (url: URL) => URL;
192
+ /**
193
+ * Updates the hash fragment of the URL.
194
+ *
195
+ * @since 1.0.0
196
+ * @category Setters
197
+ */
198
+ (url: URL, hash: string): URL;
199
+ };
200
+ /**
201
+ * Updates the host (domain and port) of the URL.
202
+ *
203
+ * @since 1.0.0
204
+ * @category Setters
205
+ */
206
+ export declare const setHost: {
207
+ /**
208
+ * Updates the host (domain and port) of the URL.
209
+ *
210
+ * @since 1.0.0
211
+ * @category Setters
212
+ */
213
+ (host: string): (url: URL) => URL;
214
+ /**
215
+ * Updates the host (domain and port) of the URL.
216
+ *
217
+ * @since 1.0.0
218
+ * @category Setters
219
+ */
220
+ (url: URL, host: string): URL;
221
+ };
222
+ /**
223
+ * Updates the domain of the URL without modifying the port.
224
+ *
225
+ * @since 1.0.0
226
+ * @category Setters
227
+ */
228
+ export declare const setHostname: {
229
+ /**
230
+ * Updates the domain of the URL without modifying the port.
231
+ *
232
+ * @since 1.0.0
233
+ * @category Setters
234
+ */
235
+ (hostname: string): (url: URL) => URL;
236
+ /**
237
+ * Updates the domain of the URL without modifying the port.
238
+ *
239
+ * @since 1.0.0
240
+ * @category Setters
241
+ */
242
+ (url: URL, hostname: string): URL;
243
+ };
244
+ /**
245
+ * Replaces the entire URL string.
246
+ *
247
+ * @since 1.0.0
248
+ * @category Setters
249
+ */
250
+ export declare const setHref: {
251
+ /**
252
+ * Replaces the entire URL string.
253
+ *
254
+ * @since 1.0.0
255
+ * @category Setters
256
+ */
257
+ (href: string): (url: URL) => URL;
258
+ /**
259
+ * Replaces the entire URL string.
260
+ *
261
+ * @since 1.0.0
262
+ * @category Setters
263
+ */
264
+ (url: URL, href: string): URL;
265
+ };
266
+ /**
267
+ * Updates the password used for authentication.
268
+ *
269
+ * @since 1.0.0
270
+ * @category Setters
271
+ */
272
+ export declare const setPassword: {
273
+ /**
274
+ * Updates the password used for authentication.
275
+ *
276
+ * @since 1.0.0
277
+ * @category Setters
278
+ */
279
+ (password: string): (url: URL) => URL;
280
+ /**
281
+ * Updates the password used for authentication.
282
+ *
283
+ * @since 1.0.0
284
+ * @category Setters
285
+ */
286
+ (url: URL, password: string): URL;
287
+ };
288
+ /**
289
+ * Updates the path of the URL.
290
+ *
291
+ * @since 1.0.0
292
+ * @category Setters
293
+ */
294
+ export declare const setPathname: {
295
+ /**
296
+ * Updates the path of the URL.
297
+ *
298
+ * @since 1.0.0
299
+ * @category Setters
300
+ */
301
+ (pathname: string): (url: URL) => URL;
302
+ /**
303
+ * Updates the path of the URL.
304
+ *
305
+ * @since 1.0.0
306
+ * @category Setters
307
+ */
308
+ (url: URL, pathname: string): URL;
309
+ };
310
+ /**
311
+ * Updates the port of the URL.
312
+ *
313
+ * @since 1.0.0
314
+ * @category Setters
315
+ */
316
+ export declare const setPort: {
317
+ /**
318
+ * Updates the port of the URL.
319
+ *
320
+ * @since 1.0.0
321
+ * @category Setters
322
+ */
323
+ (port: string): (url: URL) => URL;
324
+ /**
325
+ * Updates the port of the URL.
326
+ *
327
+ * @since 1.0.0
328
+ * @category Setters
329
+ */
330
+ (url: URL, port: string): URL;
331
+ };
332
+ /**
333
+ * Updates the protocol (e.g., `http`, `https`).
334
+ *
335
+ * @since 1.0.0
336
+ * @category Setters
337
+ */
338
+ export declare const setProtocol: {
339
+ /**
340
+ * Updates the protocol (e.g., `http`, `https`).
341
+ *
342
+ * @since 1.0.0
343
+ * @category Setters
344
+ */
345
+ (protocol: string): (url: URL) => URL;
346
+ /**
347
+ * Updates the protocol (e.g., `http`, `https`).
348
+ *
349
+ * @since 1.0.0
350
+ * @category Setters
351
+ */
352
+ (url: URL, protocol: string): URL;
353
+ };
354
+ /**
355
+ * Updates the query string of the URL.
356
+ *
357
+ * @since 1.0.0
358
+ * @category Setters
359
+ */
360
+ export declare const setSearch: {
361
+ /**
362
+ * Updates the query string of the URL.
363
+ *
364
+ * @since 1.0.0
365
+ * @category Setters
366
+ */
367
+ (search: string): (url: URL) => URL;
368
+ /**
369
+ * Updates the query string of the URL.
370
+ *
371
+ * @since 1.0.0
372
+ * @category Setters
373
+ */
374
+ (url: URL, search: string): URL;
375
+ };
376
+ /**
377
+ * Updates the username used for authentication.
378
+ *
379
+ * @since 1.0.0
380
+ * @category Setters
381
+ */
382
+ export declare const setUsername: {
383
+ /**
384
+ * Updates the username used for authentication.
385
+ *
386
+ * @since 1.0.0
387
+ * @category Setters
388
+ */
389
+ (username: string): (url: URL) => URL;
390
+ /**
391
+ * Updates the username used for authentication.
392
+ *
393
+ * @since 1.0.0
394
+ * @category Setters
395
+ */
396
+ (url: URL, username: string): URL;
397
+ };
398
+ /**
399
+ * Updates the query parameters of a URL.
400
+ *
401
+ * **Details**
402
+ *
403
+ * This function allows you to set or replace the query parameters of a `URL`
404
+ * object using the provided `UrlParams`. It creates a new `URL` object with the
405
+ * updated parameters, leaving the original object unchanged.
406
+ *
407
+ * @example
408
+ * ```ts
409
+ * import { Url, UrlParams } from "@effect/platform"
410
+ *
411
+ * const myUrl = new URL("https://example.com?foo=bar")
412
+ *
413
+ * // Write parameters
414
+ * const updatedUrl = Url.setUrlParams(
415
+ * myUrl,
416
+ * UrlParams.fromInput([["key", "value"]])
417
+ * )
418
+ *
419
+ * console.log(updatedUrl.toString())
420
+ * // Output: https://example.com/?key=value
421
+ * ```
422
+ *
423
+ * @since 1.0.0
424
+ * @category Setters
425
+ */
426
+ export declare const setUrlParams: {
427
+ /**
428
+ * Updates the query parameters of a URL.
429
+ *
430
+ * **Details**
431
+ *
432
+ * This function allows you to set or replace the query parameters of a `URL`
433
+ * object using the provided `UrlParams`. It creates a new `URL` object with the
434
+ * updated parameters, leaving the original object unchanged.
435
+ *
436
+ * @example
437
+ * ```ts
438
+ * import { Url, UrlParams } from "@effect/platform"
439
+ *
440
+ * const myUrl = new URL("https://example.com?foo=bar")
441
+ *
442
+ * // Write parameters
443
+ * const updatedUrl = Url.setUrlParams(
444
+ * myUrl,
445
+ * UrlParams.fromInput([["key", "value"]])
446
+ * )
447
+ *
448
+ * console.log(updatedUrl.toString())
449
+ * // Output: https://example.com/?key=value
450
+ * ```
451
+ *
452
+ * @since 1.0.0
453
+ * @category Setters
454
+ */
455
+ (urlParams: UrlParams.UrlParams): (url: URL) => URL;
456
+ /**
457
+ * Updates the query parameters of a URL.
458
+ *
459
+ * **Details**
460
+ *
461
+ * This function allows you to set or replace the query parameters of a `URL`
462
+ * object using the provided `UrlParams`. It creates a new `URL` object with the
463
+ * updated parameters, leaving the original object unchanged.
464
+ *
465
+ * @example
466
+ * ```ts
467
+ * import { Url, UrlParams } from "@effect/platform"
468
+ *
469
+ * const myUrl = new URL("https://example.com?foo=bar")
470
+ *
471
+ * // Write parameters
472
+ * const updatedUrl = Url.setUrlParams(
473
+ * myUrl,
474
+ * UrlParams.fromInput([["key", "value"]])
475
+ * )
476
+ *
477
+ * console.log(updatedUrl.toString())
478
+ * // Output: https://example.com/?key=value
479
+ * ```
480
+ *
481
+ * @since 1.0.0
482
+ * @category Setters
483
+ */
484
+ (url: URL, urlParams: UrlParams.UrlParams): URL;
485
+ };
486
+ /**
487
+ * Retrieves the query parameters from a URL.
488
+ *
489
+ * **Details**
490
+ *
491
+ * This function extracts the query parameters from a `URL` object and returns
492
+ * them as `UrlParams`. The resulting structure can be easily manipulated or
493
+ * inspected.
494
+ *
495
+ * @example
496
+ * ```ts
497
+ * import { Url } from "@effect/platform"
498
+ *
499
+ * const myUrl = new URL("https://example.com?foo=bar")
500
+ *
501
+ * // Read parameters
502
+ * const params = Url.urlParams(myUrl)
503
+ *
504
+ * console.log(params)
505
+ * // Output: [ [ 'foo', 'bar' ] ]
506
+ * ```
507
+ *
508
+ * @since 1.0.0
509
+ * @category Getters
510
+ */
511
+ export declare const urlParams: (url: URL) => UrlParams.UrlParams;
512
+ /**
513
+ * Reads, modifies, and updates the query parameters of a URL.
514
+ *
515
+ * **Details**
516
+ *
517
+ * This function provides a functional way to interact with query parameters by
518
+ * reading the current parameters, applying a transformation function, and then
519
+ * writing the updated parameters back to the URL. It returns a new `URL` object
520
+ * with the modified parameters, ensuring immutability.
521
+ *
522
+ * @example
523
+ * ```ts
524
+ * import { Url, UrlParams } from "@effect/platform"
525
+ *
526
+ * const myUrl = new URL("https://example.com?foo=bar")
527
+ *
528
+ * const changedUrl = Url.modifyUrlParams(myUrl, UrlParams.append("key", "value"))
529
+ *
530
+ * console.log(changedUrl.toString())
531
+ * // Output: https://example.com/?foo=bar&key=value
532
+ * ```
533
+ *
534
+ * @since 1.0.0
535
+ * @category Modifiers
536
+ */
537
+ export declare const modifyUrlParams: {
538
+ /**
539
+ * Reads, modifies, and updates the query parameters of a URL.
540
+ *
541
+ * **Details**
542
+ *
543
+ * This function provides a functional way to interact with query parameters by
544
+ * reading the current parameters, applying a transformation function, and then
545
+ * writing the updated parameters back to the URL. It returns a new `URL` object
546
+ * with the modified parameters, ensuring immutability.
547
+ *
548
+ * @example
549
+ * ```ts
550
+ * import { Url, UrlParams } from "@effect/platform"
551
+ *
552
+ * const myUrl = new URL("https://example.com?foo=bar")
553
+ *
554
+ * const changedUrl = Url.modifyUrlParams(myUrl, UrlParams.append("key", "value"))
555
+ *
556
+ * console.log(changedUrl.toString())
557
+ * // Output: https://example.com/?foo=bar&key=value
558
+ * ```
559
+ *
560
+ * @since 1.0.0
561
+ * @category Modifiers
562
+ */
563
+ (f: (urlParams: UrlParams.UrlParams) => UrlParams.UrlParams): (url: URL) => URL;
564
+ /**
565
+ * Reads, modifies, and updates the query parameters of a URL.
566
+ *
567
+ * **Details**
568
+ *
569
+ * This function provides a functional way to interact with query parameters by
570
+ * reading the current parameters, applying a transformation function, and then
571
+ * writing the updated parameters back to the URL. It returns a new `URL` object
572
+ * with the modified parameters, ensuring immutability.
573
+ *
574
+ * @example
575
+ * ```ts
576
+ * import { Url, UrlParams } from "@effect/platform"
577
+ *
578
+ * const myUrl = new URL("https://example.com?foo=bar")
579
+ *
580
+ * const changedUrl = Url.modifyUrlParams(myUrl, UrlParams.append("key", "value"))
581
+ *
582
+ * console.log(changedUrl.toString())
583
+ * // Output: https://example.com/?foo=bar&key=value
584
+ * ```
585
+ *
586
+ * @since 1.0.0
587
+ * @category Modifiers
588
+ */
589
+ (url: URL, f: (urlParams: UrlParams.UrlParams) => UrlParams.UrlParams): URL;
590
+ };
591
+ //# sourceMappingURL=Url.d.ts.map