schema-dsl 1.1.8 → 1.1.9

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 (2) hide show
  1. package/index.d.ts +106 -33
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- // Type definitions for schema-dsl v1.1.5
1
+ // Type definitions for schema-dsl v1.1.8
2
2
  // Project: https://github.com/vextjs/schema-dsl
3
3
  // Definitions by: schema-dsl Team
4
4
 
@@ -1318,12 +1318,29 @@ export namespace dsl {
1318
1318
  export const error: {
1319
1319
  /**
1320
1320
  * 创建多语言错误(不抛出)
1321
+ *
1321
1322
  * @param code - 错误代码(多语言 key)
1322
- * @param params - 错误参数
1323
+ * @param paramsOrLocale - 错误参数对象 或 语言代码(智能识别,v1.1.8+)
1323
1324
  * @param statusCode - HTTP 状态码
1324
- * @param locale - 语言环境(可选,不传则使用全局语言)
1325
+ * @param locale - 语言环境(仅当第2个参数是对象时有效)
1325
1326
  * @returns 错误实例
1326
1327
  *
1328
+ * @example 简化语法(v1.1.8+)
1329
+ * ```typescript
1330
+ * // 直接传语言参数
1331
+ * const error = dsl.error.create('account.notFound', 'zh-CN');
1332
+ * const error = dsl.error.create('account.notFound', 'en-US', 404);
1333
+ * ```
1334
+ *
1335
+ * @example 标准语法(完全兼容)
1336
+ * ```typescript
1337
+ * // 带参数对象
1338
+ * const error = dsl.error.create('account.notFound', { id: '123' }, 404, 'zh-CN');
1339
+ *
1340
+ * // 空参数对象
1341
+ * const error = dsl.error.create('account.notFound', {}, 404, 'zh-CN');
1342
+ * ```
1343
+ *
1327
1344
  * @example 全局语言
1328
1345
  * ```typescript
1329
1346
  * Locale.setLocale('zh-CN');
@@ -1338,19 +1355,36 @@ export namespace dsl {
1338
1355
  */
1339
1356
  create(
1340
1357
  code: string,
1341
- params?: Record<string, any>,
1358
+ paramsOrLocale?: Record<string, any> | string,
1342
1359
  statusCode?: number,
1343
1360
  locale?: string
1344
1361
  ): I18nError;
1345
1362
 
1346
1363
  /**
1347
1364
  * 抛出多语言错误
1365
+ *
1348
1366
  * @param code - 错误代码(多语言 key)
1349
- * @param params - 错误参数
1367
+ * @param paramsOrLocale - 错误参数对象 或 语言代码(智能识别,v1.1.8+)
1350
1368
  * @param statusCode - HTTP 状态码
1351
- * @param locale - 语言环境(可选,不传则使用全局语言)
1369
+ * @param locale - 语言环境(仅当第2个参数是对象时有效)
1352
1370
  * @throws I18nError
1353
1371
  *
1372
+ * @example 简化语法(v1.1.8+)
1373
+ * ```typescript
1374
+ * // 直接传语言参数
1375
+ * dsl.error.throw('account.notFound', 'zh-CN');
1376
+ * dsl.error.throw('account.notFound', 'en-US', 404);
1377
+ * ```
1378
+ *
1379
+ * @example 标准语法(完全兼容)
1380
+ * ```typescript
1381
+ * // 带参数对象
1382
+ * dsl.error.throw('account.notFound', { id: '123' }, 404, 'zh-CN');
1383
+ *
1384
+ * // 空参数对象
1385
+ * dsl.error.throw('account.notFound', {}, 404, 'zh-CN');
1386
+ * ```
1387
+ *
1354
1388
  * @example 全局语言
1355
1389
  * ```typescript
1356
1390
  * Locale.setLocale('zh-CN');
@@ -1364,20 +1398,37 @@ export namespace dsl {
1364
1398
  */
1365
1399
  throw(
1366
1400
  code: string,
1367
- params?: Record<string, any>,
1401
+ paramsOrLocale?: Record<string, any> | string,
1368
1402
  statusCode?: number,
1369
1403
  locale?: string
1370
1404
  ): never;
1371
1405
 
1372
1406
  /**
1373
1407
  * 断言方法 - 条件不满足时抛错
1408
+ *
1374
1409
  * @param condition - 条件表达式
1375
1410
  * @param code - 错误代码(多语言 key)
1376
- * @param params - 错误参数
1411
+ * @param paramsOrLocale - 错误参数对象 或 语言代码(智能识别,v1.1.8+)
1377
1412
  * @param statusCode - HTTP 状态码
1378
- * @param locale - 语言环境(可选,不传则使用全局语言)
1413
+ * @param locale - 语言环境(仅当第3个参数是对象时有效)
1379
1414
  * @throws I18nError 条件为 false 时抛出
1380
1415
  *
1416
+ * @example 简化语法(v1.1.8+)
1417
+ * ```typescript
1418
+ * // 直接传语言参数
1419
+ * dsl.error.assert(account, 'account.notFound', 'zh-CN');
1420
+ * dsl.error.assert(account, 'account.notFound', 'en-US', 404);
1421
+ * ```
1422
+ *
1423
+ * @example 标准语法(完全兼容)
1424
+ * ```typescript
1425
+ * // 带参数对象
1426
+ * dsl.error.assert(account, 'account.notFound', { id: '123' }, 404, 'zh-CN');
1427
+ *
1428
+ * // 空参数对象
1429
+ * dsl.error.assert(account, 'account.notFound', {}, 404, 'zh-CN');
1430
+ * ```
1431
+ *
1381
1432
  * @example 全局语言
1382
1433
  * ```typescript
1383
1434
  * Locale.setLocale('zh-CN');
@@ -1392,7 +1443,7 @@ export namespace dsl {
1392
1443
  assert(
1393
1444
  condition: any,
1394
1445
  code: string,
1395
- params?: Record<string, any>,
1446
+ paramsOrLocale?: Record<string, any> | string,
1396
1447
  statusCode?: number,
1397
1448
  locale?: string
1398
1449
  ): asserts condition;
@@ -1786,12 +1837,26 @@ export class I18nError extends Error {
1786
1837
 
1787
1838
  /**
1788
1839
  * 静态工厂方法 - 创建错误(不抛出)
1840
+ *
1789
1841
  * @param code - 错误代码
1790
- * @param params - 错误参数
1842
+ * @param paramsOrLocale - 错误参数对象 或 语言代码(智能识别,v1.1.8+)
1791
1843
  * @param statusCode - HTTP 状态码
1792
- * @param locale - 语言环境(可选,不传则使用全局语言)
1844
+ * @param locale - 语言环境(仅当第2个参数是对象时有效)
1793
1845
  * @returns 错误实例
1794
1846
  *
1847
+ * @example 简化语法(v1.1.8+)
1848
+ * ```typescript
1849
+ * // 直接传语言参数
1850
+ * const error = I18nError.create('account.notFound', 'zh-CN');
1851
+ * const error = I18nError.create('account.notFound', 'en-US', 404);
1852
+ * ```
1853
+ *
1854
+ * @example 标准语法(完全兼容)
1855
+ * ```typescript
1856
+ * // 带参数对象
1857
+ * const error = I18nError.create('account.notFound', { id: '123' }, 404, 'zh-CN');
1858
+ * ```
1859
+ *
1795
1860
  * @example 全局语言
1796
1861
  * ```typescript
1797
1862
  * Locale.setLocale('zh-CN');
@@ -1810,19 +1875,33 @@ export class I18nError extends Error {
1810
1875
  */
1811
1876
  static create(
1812
1877
  code: string,
1813
- params?: Record<string, any>,
1878
+ paramsOrLocale?: Record<string, any> | string,
1814
1879
  statusCode?: number,
1815
1880
  locale?: string
1816
1881
  ): I18nError;
1817
1882
 
1818
1883
  /**
1819
1884
  * 静态工厂方法 - 直接抛出错误
1885
+ *
1820
1886
  * @param code - 错误代码
1821
- * @param params - 错误参数
1887
+ * @param paramsOrLocale - 错误参数对象 或 语言代码(智能识别,v1.1.8+)
1822
1888
  * @param statusCode - HTTP 状态码
1823
- * @param locale - 语言环境(可选,不传则使用全局语言)
1889
+ * @param locale - 语言环境(仅当第2个参数是对象时有效)
1824
1890
  * @throws I18nError
1825
1891
  *
1892
+ * @example 简化语法(v1.1.8+)
1893
+ * ```typescript
1894
+ * // 直接传语言参数
1895
+ * I18nError.throw('account.notFound', 'zh-CN');
1896
+ * I18nError.throw('account.notFound', 'en-US', 404);
1897
+ * ```
1898
+ *
1899
+ * @example 标准语法(完全兼容)
1900
+ * ```typescript
1901
+ * // 带参数对象
1902
+ * I18nError.throw('account.notFound', { id: '123' }, 404, 'zh-CN');
1903
+ * ```
1904
+ *
1826
1905
  * @example 全局语言
1827
1906
  * ```typescript
1828
1907
  * Locale.setLocale('zh-CN');
@@ -1836,39 +1915,33 @@ export class I18nError extends Error {
1836
1915
  */
1837
1916
  static throw(
1838
1917
  code: string,
1839
- params?: Record<string, any>,
1918
+ paramsOrLocale?: Record<string, any> | string,
1840
1919
  statusCode?: number,
1841
1920
  locale?: string
1842
1921
  ): never;
1843
1922
 
1844
1923
  /**
1845
1924
  * 断言方法 - 条件不满足时抛错
1925
+ *
1846
1926
  * @param condition - 条件表达式
1847
1927
  * @param code - 错误代码
1848
- * @param params - 错误参数
1928
+ * @param paramsOrLocale - 错误参数对象 或 语言代码(智能识别,v1.1.8+)
1849
1929
  * @param statusCode - HTTP 状态码
1850
- * @param locale - 语言环境(可选,不传则使用全局语言)
1930
+ * @param locale - 语言环境(仅当第3个参数是对象时有效)
1851
1931
  * @throws I18nError 条件为 false 时抛出
1852
1932
  *
1853
- * @example 全局语言
1933
+ * @example 简化语法(v1.1.8+)
1854
1934
  * ```typescript
1855
- * Locale.setLocale('zh-CN');
1856
- * I18nError.assert(account, 'account.notFound');
1935
+ * // 直接传语言参数
1936
+ * I18nError.assert(account, 'account.notFound', 'zh-CN');
1937
+ * I18nError.assert(account, 'account.notFound', 'en-US', 404);
1857
1938
  * ```
1858
1939
  *
1859
- * @example 运行时指定语言
1940
+ * @example 标准语法(完全兼容)
1860
1941
  * ```typescript
1861
- * I18nError.assert(account, 'account.notFound', {}, 404, 'en-US');
1942
+ * // 带参数对象
1943
+ * I18nError.assert(account, 'account.notFound', { id: '123' }, 404, 'zh-CN');
1862
1944
  * ```
1863
- */
1864
- /**
1865
- * 断言方法 - 条件不满足时抛错
1866
- * @param condition - 条件表达式
1867
- * @param code - 错误代码
1868
- * @param params - 错误参数
1869
- * @param statusCode - HTTP 状态码
1870
- * @param locale - 语言环境(可选,不传则使用全局语言)
1871
- * @throws I18nError 条件为 false 时抛出
1872
1945
  *
1873
1946
  * @example 全局语言
1874
1947
  * ```typescript
@@ -1884,7 +1957,7 @@ export class I18nError extends Error {
1884
1957
  static assert(
1885
1958
  condition: any,
1886
1959
  code: string,
1887
- params?: Record<string, any>,
1960
+ paramsOrLocale?: Record<string, any> | string,
1888
1961
  statusCode?: number,
1889
1962
  locale?: string
1890
1963
  ): asserts condition;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "schema-dsl",
3
- "version": "1.1.8",
3
+ "version": "1.1.9",
4
4
  "description": "简洁强大的JSON Schema验证库 - DSL语法 + String扩展 + 便捷validate",
5
5
  "main": "index.js",
6
6
  "types": "index.d.ts",