shelving 1.309.0 → 1.311.0
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.
- package/README.md +13 -0
- package/docs/api/APICache/call.md +15 -0
- package/docs/api/APICache/get.md +13 -0
- package/docs/api/APICache/invalidate.md +12 -0
- package/docs/api/APICache/invalidateAll.md +12 -0
- package/docs/api/APICache/refresh.md +12 -0
- package/docs/api/APICache/refreshAll.md +12 -0
- package/docs/api/APICache.md +49 -0
- package/docs/api/APIProvider/call.md +13 -0
- package/docs/api/APIProvider/createRequest.md +12 -0
- package/docs/api/APIProvider/fetch.md +12 -0
- package/docs/api/APIProvider/parseResponse.md +14 -0
- package/docs/api/APIProvider/renderURL.md +13 -0
- package/docs/api/APIProvider.md +52 -0
- package/docs/api/AnyEndpoint.md +16 -0
- package/docs/api/AnyEndpointHandler.md +16 -0
- package/docs/api/CachedAPIProvider/invalidate.md +12 -0
- package/docs/api/CachedAPIProvider/invalidateAll.md +12 -0
- package/docs/api/CachedAPIProvider/refresh.md +12 -0
- package/docs/api/CachedAPIProvider/refreshAll.md +12 -0
- package/docs/api/CachedAPIProvider.md +65 -0
- package/docs/api/ClientAPIProvider.md +60 -0
- package/docs/api/ClientAPIProviderOptions.md +24 -0
- package/docs/api/DELETE.md +43 -0
- package/docs/api/DebugAPIProvider.md +37 -0
- package/docs/api/Endpoint/handler.md +12 -0
- package/docs/api/Endpoint/match.md +12 -0
- package/docs/api/Endpoint/renderPath.md +13 -0
- package/docs/api/Endpoint/toString.md +12 -0
- package/docs/api/Endpoint.md +52 -0
- package/docs/api/EndpointCache/call.md +15 -0
- package/docs/api/EndpointCache/get.md +13 -0
- package/docs/api/EndpointCache/invalidate.md +12 -0
- package/docs/api/EndpointCache/invalidateAll.md +12 -0
- package/docs/api/EndpointCache/refresh.md +12 -0
- package/docs/api/EndpointCache/refreshAll.md +12 -0
- package/docs/api/EndpointCache.md +51 -0
- package/docs/api/EndpointCallback.md +25 -0
- package/docs/api/EndpointHandler.md +23 -0
- package/docs/api/EndpointHandlers.md +17 -0
- package/docs/api/EndpointStore.md +41 -0
- package/docs/api/EndpointType.md +17 -0
- package/docs/api/Endpoints.md +17 -0
- package/docs/api/GET.md +43 -0
- package/docs/api/HEAD.md +43 -0
- package/docs/api/HydratingAPIProvider.md +97 -0
- package/docs/api/JSONAPIProvider.md +37 -0
- package/docs/api/LoggingAPIProvider.md +53 -0
- package/docs/api/MockAPIFetchCall.md +27 -0
- package/docs/api/MockAPIProvider.md +57 -0
- package/docs/api/MockAPIRequestCall.md +32 -0
- package/docs/api/MockAPIResponseCall.md +29 -0
- package/docs/api/MockEndpointAPIProvider.md +50 -0
- package/docs/api/PATCH.md +43 -0
- package/docs/api/POST.md +43 -0
- package/docs/api/PUT.md +43 -0
- package/docs/api/PayloadType.md +17 -0
- package/docs/api/ThroughAPIProvider.md +59 -0
- package/docs/api/ValidationAPIProvider.md +39 -0
- package/docs/api/XMLAPIProvider.md +36 -0
- package/docs/api/handleEndpoints.md +50 -0
- package/docs/api.md +169 -0
- package/docs/bun/BunPostgresProvider.md +30 -0
- package/docs/bun.md +78 -0
- package/docs/cloudflare/CloudflareD1Provider.md +30 -0
- package/docs/cloudflare/CloudflareKVProvider.md +44 -0
- package/docs/cloudflare/D1Database/batch.md +10 -0
- package/docs/cloudflare/D1Database/exec.md +10 -0
- package/docs/cloudflare/D1Database/prepare.md +10 -0
- package/docs/cloudflare/D1Database.md +26 -0
- package/docs/cloudflare/D1ExecResult.md +22 -0
- package/docs/cloudflare/D1Meta.md +28 -0
- package/docs/cloudflare/D1PreparedStatement/bind.md +10 -0
- package/docs/cloudflare/D1PreparedStatement/first.md +10 -0
- package/docs/cloudflare/D1PreparedStatement/raw.md +10 -0
- package/docs/cloudflare/D1PreparedStatement/run.md +10 -0
- package/docs/cloudflare/D1PreparedStatement.md +26 -0
- package/docs/cloudflare/D1Result.md +24 -0
- package/docs/cloudflare/D1Value.md +12 -0
- package/docs/cloudflare/KVNamespace/delete.md +10 -0
- package/docs/cloudflare/KVNamespace/get.md +10 -0
- package/docs/cloudflare/KVNamespace/put.md +10 -0
- package/docs/cloudflare/KVNamespace.md +24 -0
- package/docs/cloudflare.md +96 -0
- package/docs/db/COLLECTION.md +34 -0
- package/docs/db/Collection.md +49 -0
- package/docs/db/CollectionCache/getItem.md +12 -0
- package/docs/db/CollectionCache/getQuery.md +12 -0
- package/docs/db/CollectionCache/refreshAll.md +12 -0
- package/docs/db/CollectionCache/refreshItem.md +12 -0
- package/docs/db/CollectionCache/refreshItems.md +12 -0
- package/docs/db/CollectionCache/refreshQueries.md +12 -0
- package/docs/db/CollectionCache/refreshQuery.md +12 -0
- package/docs/db/CollectionCache.md +52 -0
- package/docs/db/CollectionData.md +17 -0
- package/docs/db/CollectionIdentifier.md +17 -0
- package/docs/db/CollectionItem.md +18 -0
- package/docs/db/CollectionItemSchema.md +42 -0
- package/docs/db/CollectionItems.md +18 -0
- package/docs/db/CollectionItemsSchema.md +43 -0
- package/docs/db/CollectionName.md +17 -0
- package/docs/db/CollectionNames.md +12 -0
- package/docs/db/CollectionQueryItemsSchema.md +44 -0
- package/docs/db/CollectionQuerySchema.md +36 -0
- package/docs/db/Collections.md +17 -0
- package/docs/db/CollectionsDatabase.md +25 -0
- package/docs/db/DBCache/get.md +13 -0
- package/docs/db/DBCache/getItem.md +12 -0
- package/docs/db/DBCache/getQuery.md +12 -0
- package/docs/db/DBCache/refreshAll.md +12 -0
- package/docs/db/DBCache/refreshItem.md +12 -0
- package/docs/db/DBCache/refreshItems.md +12 -0
- package/docs/db/DBCache/refreshQueries.md +12 -0
- package/docs/db/DBCache/refreshQuery.md +12 -0
- package/docs/db/DBCache.md +52 -0
- package/docs/db/DBMigrator/migrate.md +12 -0
- package/docs/db/DBMigrator.md +36 -0
- package/docs/db/DBOperation.md +35 -0
- package/docs/db/DBOperations.md +17 -0
- package/docs/db/DBProvider/addItem.md +12 -0
- package/docs/db/DBProvider/countQuery.md +12 -0
- package/docs/db/DBProvider/deleteItem.md +12 -0
- package/docs/db/DBProvider/deleteQuery.md +14 -0
- package/docs/db/DBProvider/getFirst.md +12 -0
- package/docs/db/DBProvider/getItem.md +12 -0
- package/docs/db/DBProvider/getItemSequence.md +12 -0
- package/docs/db/DBProvider/getQuery.md +12 -0
- package/docs/db/DBProvider/getQuerySequence.md +12 -0
- package/docs/db/DBProvider/requireFirst.md +12 -0
- package/docs/db/DBProvider/requireItem.md +12 -0
- package/docs/db/DBProvider/setItem.md +12 -0
- package/docs/db/DBProvider/setQuery.md +14 -0
- package/docs/db/DBProvider/transact.md +19 -0
- package/docs/db/DBProvider/updateItem.md +12 -0
- package/docs/db/DBProvider/updateQuery.md +14 -0
- package/docs/db/DBProvider.md +95 -0
- package/docs/db/DebugDBProvider.md +29 -0
- package/docs/db/ID.md +6 -0
- package/docs/db/ItemStore.md +47 -0
- package/docs/db/MemoryDBProvider/clone.md +15 -0
- package/docs/db/MemoryDBProvider/createTable.md +13 -0
- package/docs/db/MemoryDBProvider/getTable.md +12 -0
- package/docs/db/MemoryDBProvider/setItems.md +12 -0
- package/docs/db/MemoryDBProvider.md +83 -0
- package/docs/db/MemoryTable/addItem.md +12 -0
- package/docs/db/MemoryTable/clone.md +15 -0
- package/docs/db/MemoryTable/countQuery.md +12 -0
- package/docs/db/MemoryTable/deleteItem.md +14 -0
- package/docs/db/MemoryTable/deleteQuery.md +10 -0
- package/docs/db/MemoryTable/generateUniqueID.md +13 -0
- package/docs/db/MemoryTable/getItem.md +12 -0
- package/docs/db/MemoryTable/getItemSequence.md +14 -0
- package/docs/db/MemoryTable/getItemTime.md +13 -0
- package/docs/db/MemoryTable/getQuery.md +12 -0
- package/docs/db/MemoryTable/getQuerySequence.md +14 -0
- package/docs/db/MemoryTable/getQueryTime.md +14 -0
- package/docs/db/MemoryTable/setItem.md +14 -0
- package/docs/db/MemoryTable/setItemSequence.md +13 -0
- package/docs/db/MemoryTable/setItems.md +10 -0
- package/docs/db/MemoryTable/setItemsSequence.md +10 -0
- package/docs/db/MemoryTable/setQuery.md +12 -0
- package/docs/db/MemoryTable/setQueryTime.md +14 -0
- package/docs/db/MemoryTable/updateItem.md +13 -0
- package/docs/db/MemoryTable/updateQuery.md +12 -0
- package/docs/db/MemoryTable.md +65 -0
- package/docs/db/MockDBCall.md +49 -0
- package/docs/db/MockDBProvider.md +36 -0
- package/docs/db/OptionalCollectionItem.md +18 -0
- package/docs/db/PostgresMigrator.md +19 -0
- package/docs/db/PostgresProvider.md +39 -0
- package/docs/db/QueryStore.md +52 -0
- package/docs/db/RecordingDBProvider/replay.md +14 -0
- package/docs/db/RecordingDBProvider/replayReads.md +13 -0
- package/docs/db/RecordingDBProvider/replayWrites.md +13 -0
- package/docs/db/RecordingDBProvider.md +72 -0
- package/docs/db/SQLColumn.md +24 -0
- package/docs/db/SQLFragment.md +35 -0
- package/docs/db/SQLMigrator/getCreateTableColumns.md +12 -0
- package/docs/db/SQLMigrator/getCreateTableQuery.md +12 -0
- package/docs/db/SQLMigrator/getGeneratedTableColumns.md +12 -0
- package/docs/db/SQLMigrator/getMigrations.md +12 -0
- package/docs/db/SQLMigrator/migrate.md +12 -0
- package/docs/db/SQLMigrator.md +29 -0
- package/docs/db/SQLProvider/exec.md +12 -0
- package/docs/db/SQLProvider/sql.md +12 -0
- package/docs/db/SQLProvider/sqlClauses.md +12 -0
- package/docs/db/SQLProvider/sqlConcat.md +12 -0
- package/docs/db/SQLProvider/sqlExtract.md +13 -0
- package/docs/db/SQLProvider/sqlFilter.md +12 -0
- package/docs/db/SQLProvider/sqlIdentifier.md +12 -0
- package/docs/db/SQLProvider/sqlLimit.md +13 -0
- package/docs/db/SQLProvider/sqlOrder.md +14 -0
- package/docs/db/SQLProvider/sqlSetters.md +12 -0
- package/docs/db/SQLProvider/sqlSort.md +12 -0
- package/docs/db/SQLProvider/sqlUpdate.md +15 -0
- package/docs/db/SQLProvider/sqlUpdates.md +12 -0
- package/docs/db/SQLProvider/sqlValues.md +12 -0
- package/docs/db/SQLProvider/sqlWhere.md +14 -0
- package/docs/db/SQLProvider.md +61 -0
- package/docs/db/SQLTable.md +30 -0
- package/docs/db/SQLTableColumn.md +22 -0
- package/docs/db/SQLiteMigrator.md +19 -0
- package/docs/db/SQLiteProvider.md +43 -0
- package/docs/db/StorageDBProvider.md +98 -0
- package/docs/db/StorageTable.md +31 -0
- package/docs/db/ThroughDBProvider/cloneWith.md +12 -0
- package/docs/db/ThroughDBProvider.md +81 -0
- package/docs/db/UndoDBProvider/undo.md +16 -0
- package/docs/db/UndoDBProvider.md +64 -0
- package/docs/db/ValidationDBProvider.md +43 -0
- package/docs/db/replayOperations.md +35 -0
- package/docs/db.md +191 -0
- package/docs/error/BaseError.md +17 -0
- package/docs/error/BaseErrorOptions.md +23 -0
- package/docs/error/Errors.md +36 -0
- package/docs/error/ForbiddenError.md +33 -0
- package/docs/error/MethodNotAllowedError.md +33 -0
- package/docs/error/NetworkError.md +47 -0
- package/docs/error/NotFoundError.md +33 -0
- package/docs/error/RequestError.md +55 -0
- package/docs/error/RequiredError.md +45 -0
- package/docs/error/ResponseError.md +49 -0
- package/docs/error/UnauthorizedError.md +33 -0
- package/docs/error/UnexpectedError.md +44 -0
- package/docs/error/UnprocessableError.md +33 -0
- package/docs/error/UnsupportedError.md +45 -0
- package/docs/error/ValueError.md +45 -0
- package/docs/error/setBaseErrorOptions.md +30 -0
- package/docs/error.md +101 -0
- package/docs/extract/DirectoryExtractor.md +39 -0
- package/docs/extract/DirectoryExtractorOptions.md +24 -0
- package/docs/extract/Extractor/extract.md +12 -0
- package/docs/extract/Extractor.md +32 -0
- package/docs/extract/FileExtractor/extract.md +12 -0
- package/docs/extract/FileExtractor/extractProps.md +15 -0
- package/docs/extract/FileExtractor.md +37 -0
- package/docs/extract/IndexExtractor.md +37 -0
- package/docs/extract/IndexExtractorOptions.md +20 -0
- package/docs/extract/MarkupExtractor.md +31 -0
- package/docs/extract/MergingExtractor.md +39 -0
- package/docs/extract/MergingExtractorOptions.md +20 -0
- package/docs/extract/ModuleExtractor.md +29 -0
- package/docs/extract/ModuleExtractorInput.md +22 -0
- package/docs/extract/PackageExtractor.md +42 -0
- package/docs/extract/PackageExtractorOptions.md +26 -0
- package/docs/extract/ThroughExtractor/extract.md +13 -0
- package/docs/extract/ThroughExtractor.md +43 -0
- package/docs/extract/TypescriptExtractor.md +41 -0
- package/docs/extract/extractMarkdownProps.md +33 -0
- package/docs/extract/mergeTreeElements.md +37 -0
- package/docs/extract.md +139 -0
- package/docs/firebase/FirestoreFields.md +18 -0
- package/docs/firebase/FirestoreProvider.md +42 -0
- package/docs/firebase/FirestoreProviderOptions.md +28 -0
- package/docs/firebase/FirestoreValue.md +46 -0
- package/docs/firebase/toData.md +37 -0
- package/docs/firebase/toDataValue.md +51 -0
- package/docs/firebase/toFirestoreFields.md +39 -0
- package/docs/firebase/toFirestoreValue.md +40 -0
- package/docs/firebase.md +86 -0
- package/docs/index.md +124 -0
- package/docs/llms-full.txt +64029 -0
- package/docs/llms.txt +98 -0
- package/docs/markup/AUTOLINK_RULE.md +16 -0
- package/docs/markup/BLOCKQUOTE_RULE.md +16 -0
- package/docs/markup/BLOCK_CONTENT_REGEXP.md +6 -0
- package/docs/markup/BLOCK_END_REGEXP.md +6 -0
- package/docs/markup/BLOCK_SPACE_REGEXP.md +6 -0
- package/docs/markup/BLOCK_START_REGEXP.md +6 -0
- package/docs/markup/CODE_RULE.md +17 -0
- package/docs/markup/FENCED_RULE.md +18 -0
- package/docs/markup/HEADING_RULE.md +16 -0
- package/docs/markup/INLINE_RULE.md +22 -0
- package/docs/markup/LINEBREAK_RULE.md +19 -0
- package/docs/markup/LINE_CONTENT_REGEXP.md +6 -0
- package/docs/markup/LINE_END_REGEXP.md +6 -0
- package/docs/markup/LINE_SPACE_REGEXP.md +6 -0
- package/docs/markup/LINE_START_REGEXP.md +6 -0
- package/docs/markup/LINK_RULE.md +17 -0
- package/docs/markup/MARKUP_PARSER.md +13 -0
- package/docs/markup/MARKUP_RULES.md +23 -0
- package/docs/markup/MARKUP_RULES_BLOCK.md +18 -0
- package/docs/markup/MARKUP_RULES_INLINE.md +18 -0
- package/docs/markup/MarkupContexts.md +12 -0
- package/docs/markup/MarkupOptions.md +40 -0
- package/docs/markup/MarkupParser/getLink.md +12 -0
- package/docs/markup/MarkupParser/getRules.md +12 -0
- package/docs/markup/MarkupParser/nested.md +14 -0
- package/docs/markup/MarkupParser/parse.md +17 -0
- package/docs/markup/MarkupParser.md +55 -0
- package/docs/markup/MarkupRule/render.md +12 -0
- package/docs/markup/MarkupRule.md +31 -0
- package/docs/markup/MarkupRules.md +16 -0
- package/docs/markup/ORDERED_RULE.md +18 -0
- package/docs/markup/PARAGRAPH_RULE.md +15 -0
- package/docs/markup/Parser/parse.md +12 -0
- package/docs/markup/Parser.md +32 -0
- package/docs/markup/SEPARATOR_RULE.md +16 -0
- package/docs/markup/TABLE_RULE.md +17 -0
- package/docs/markup/UNORDERED_RULE.md +19 -0
- package/docs/markup/WORD_CONTENT_REGEXP.md +6 -0
- package/docs/markup/WORD_END_REGEXP.md +6 -0
- package/docs/markup/WORD_START_REGEXP.md +6 -0
- package/docs/markup/createBlockRegExp.md +39 -0
- package/docs/markup/createLineRegExp.md +39 -0
- package/docs/markup/createMarkupRule.md +44 -0
- package/docs/markup/createWordRegExp.md +39 -0
- package/docs/markup.md +187 -0
- package/docs/react/APIContext/requireAPICache.md +12 -0
- package/docs/react/APIContext/useAPI.md +13 -0
- package/docs/react/APIContext.md +28 -0
- package/docs/react/DBContext/requireDBCache.md +12 -0
- package/docs/react/DBContext/useItem.md +13 -0
- package/docs/react/DBContext/useQuery.md +13 -0
- package/docs/react/DBContext.md +43 -0
- package/docs/react/createAPIContext.md +66 -0
- package/docs/react/createDBContext.md +66 -0
- package/docs/react/useInstance.md +46 -0
- package/docs/react/useLazy.md +48 -0
- package/docs/react/useMap.md +39 -0
- package/docs/react/useReduce.md +54 -0
- package/docs/react/useSequence.md +49 -0
- package/docs/react/useStore.md +61 -0
- package/docs/react.md +89 -0
- package/docs/schema/ADDRESS.md +12 -0
- package/docs/schema/ARRAY.md +32 -0
- package/docs/schema/AddressSchema.md +35 -0
- package/docs/schema/AddressSchemaOptions.md +23 -0
- package/docs/schema/ArraySchema.md +77 -0
- package/docs/schema/ArraySchemaOptions.md +31 -0
- package/docs/schema/BOOLEAN.md +12 -0
- package/docs/schema/BooleanSchema/validate.md +12 -0
- package/docs/schema/BooleanSchema.md +55 -0
- package/docs/schema/BooleanSchemaOptions.md +23 -0
- package/docs/schema/CHOICE.md +32 -0
- package/docs/schema/COLOR.md +12 -0
- package/docs/schema/COUNTRY.md +12 -0
- package/docs/schema/CURRENCY_AMOUNT.md +38 -0
- package/docs/schema/CURRENCY_CODE.md +12 -0
- package/docs/schema/ChoiceInputType.md +12 -0
- package/docs/schema/ChoiceOptions.md +12 -0
- package/docs/schema/ChoiceSchema/get.md +15 -0
- package/docs/schema/ChoiceSchema/validate.md +12 -0
- package/docs/schema/ChoiceSchema.md +75 -0
- package/docs/schema/ChoiceSchemaOptions.md +29 -0
- package/docs/schema/ColorSchema.md +38 -0
- package/docs/schema/ColorSchemaOptions.md +29 -0
- package/docs/schema/CountrySchema.md +36 -0
- package/docs/schema/CountrySchemaOptions.md +21 -0
- package/docs/schema/CurrencyAmountSchema.md +52 -0
- package/docs/schema/CurrencyAmountSchemaOptions.md +23 -0
- package/docs/schema/CurrencyCodeSchema.md +45 -0
- package/docs/schema/CurrencyCodeSchemaOptions.md +31 -0
- package/docs/schema/DATA.md +32 -0
- package/docs/schema/DATE.md +12 -0
- package/docs/schema/DATETIME.md +12 -0
- package/docs/schema/DICTIONARY.md +32 -0
- package/docs/schema/DataSchema/omit.md +12 -0
- package/docs/schema/DataSchema/pick.md +12 -0
- package/docs/schema/DataSchema.md +97 -0
- package/docs/schema/DataSchemaOptions.md +23 -0
- package/docs/schema/DateInputType.md +12 -0
- package/docs/schema/DateSchema/stringify.md +12 -0
- package/docs/schema/DateSchema.md +53 -0
- package/docs/schema/DateSchemaOptions.md +29 -0
- package/docs/schema/DateTimeSchema.md +41 -0
- package/docs/schema/DictionarySchema.md +57 -0
- package/docs/schema/DictionarySchemaOptions.md +27 -0
- package/docs/schema/EMAIL.md +12 -0
- package/docs/schema/ENTITY.md +12 -0
- package/docs/schema/EUR_AMOUNT.md +12 -0
- package/docs/schema/EmailSchema.md +49 -0
- package/docs/schema/EmailSchemaOptions.md +29 -0
- package/docs/schema/EntitySchema.md +42 -0
- package/docs/schema/EntitySchemaOptions.md +21 -0
- package/docs/schema/FILE.md +12 -0
- package/docs/schema/FileSchema.md +41 -0
- package/docs/schema/FileSchemaOptions.md +21 -0
- package/docs/schema/GBP_AMOUNT.md +12 -0
- package/docs/schema/IMAGE.md +12 -0
- package/docs/schema/INTEGER.md +12 -0
- package/docs/schema/ITEM.md +33 -0
- package/docs/schema/ImageSchema.md +28 -0
- package/docs/schema/KEY.md +12 -0
- package/docs/schema/KeySchema.md +45 -0
- package/docs/schema/MEDIA.md +12 -0
- package/docs/schema/MediaSchema.md +35 -0
- package/docs/schema/MediaSchemaOptions.md +21 -0
- package/docs/schema/NAME.md +12 -0
- package/docs/schema/NEGATIVE_INTEGER.md +12 -0
- package/docs/schema/NON_NEGATIVE_INTEGER.md +12 -0
- package/docs/schema/NON_POSITIVE_INTEGER.md +12 -0
- package/docs/schema/NULL.md +18 -0
- package/docs/schema/NULLABLE.md +32 -0
- package/docs/schema/NULLABLE_ADDRESS.md +12 -0
- package/docs/schema/NULLABLE_COLOR.md +12 -0
- package/docs/schema/NULLABLE_COUNTRY.md +12 -0
- package/docs/schema/NULLABLE_CURRENCY_AMOUNT.md +38 -0
- package/docs/schema/NULLABLE_CURRENCY_CODE.md +12 -0
- package/docs/schema/NULLABLE_DATA.md +32 -0
- package/docs/schema/NULLABLE_DATE.md +12 -0
- package/docs/schema/NULLABLE_DATETIME.md +12 -0
- package/docs/schema/NULLABLE_EMAIL.md +12 -0
- package/docs/schema/NULLABLE_ENTITY.md +12 -0
- package/docs/schema/NULLABLE_EUR_AMOUNT.md +12 -0
- package/docs/schema/NULLABLE_FILE.md +12 -0
- package/docs/schema/NULLABLE_GBP_AMOUNT.md +12 -0
- package/docs/schema/NULLABLE_IMAGE.md +12 -0
- package/docs/schema/NULLABLE_INTEGER.md +12 -0
- package/docs/schema/NULLABLE_KEY.md +12 -0
- package/docs/schema/NULLABLE_MEDIA.md +12 -0
- package/docs/schema/NULLABLE_NAME.md +12 -0
- package/docs/schema/NULLABLE_NUMBER.md +12 -0
- package/docs/schema/NULLABLE_PHONE.md +12 -0
- package/docs/schema/NULLABLE_SLUG.md +12 -0
- package/docs/schema/NULLABLE_TIME.md +12 -0
- package/docs/schema/NULLABLE_TIMESTAMP.md +12 -0
- package/docs/schema/NULLABLE_TITLE.md +12 -0
- package/docs/schema/NULLABLE_URI_SCHEMA.md +12 -0
- package/docs/schema/NULLABLE_URL_SCHEMA.md +12 -0
- package/docs/schema/NULLABLE_USD_AMOUNT.md +12 -0
- package/docs/schema/NULLABLE_UUID.md +12 -0
- package/docs/schema/NULLABLE_VIDEO.md +12 -0
- package/docs/schema/NUMBER.md +12 -0
- package/docs/schema/NullableSchema.md +46 -0
- package/docs/schema/NullableSchemaOptions.md +21 -0
- package/docs/schema/NumberSchema.md +78 -0
- package/docs/schema/NumberSchemaOptions.md +27 -0
- package/docs/schema/OPTIONAL.md +32 -0
- package/docs/schema/OptionalSchema.md +45 -0
- package/docs/schema/OptionalSchemaOptions.md +21 -0
- package/docs/schema/PARTIAL.md +32 -0
- package/docs/schema/PASSWORD.md +12 -0
- package/docs/schema/PHONE.md +12 -0
- package/docs/schema/POSITIVE_INTEGER.md +12 -0
- package/docs/schema/PasswordSchema.md +42 -0
- package/docs/schema/PhoneSchema.md +38 -0
- package/docs/schema/PhoneSchemaOptions.md +29 -0
- package/docs/schema/PossibleChoiceOptions.md +20 -0
- package/docs/schema/REQUIRED.md +32 -0
- package/docs/schema/REQUIRED_STRING.md +12 -0
- package/docs/schema/RequiredSchema.md +29 -0
- package/docs/schema/SLUG.md +12 -0
- package/docs/schema/STRING.md +12 -0
- package/docs/schema/Schema/format.md +12 -0
- package/docs/schema/Schema/validate.md +12 -0
- package/docs/schema/Schema.md +60 -0
- package/docs/schema/SchemaOptions.md +30 -0
- package/docs/schema/SchemaType.md +23 -0
- package/docs/schema/Schemas.md +17 -0
- package/docs/schema/SlugSchema.md +41 -0
- package/docs/schema/SlugSchemaOptions.md +31 -0
- package/docs/schema/StringInputType.md +12 -0
- package/docs/schema/StringSchema/sanitize.md +15 -0
- package/docs/schema/StringSchema.md +96 -0
- package/docs/schema/StringSchemaOptions.md +35 -0
- package/docs/schema/TIME.md +12 -0
- package/docs/schema/TIMESTAMP.md +12 -0
- package/docs/schema/TITLE.md +12 -0
- package/docs/schema/ThroughSchema/validate.md +12 -0
- package/docs/schema/ThroughSchema.md +43 -0
- package/docs/schema/ThroughSchemaOptions.md +21 -0
- package/docs/schema/TimeSchema.md +39 -0
- package/docs/schema/UNDEFINED.md +18 -0
- package/docs/schema/UNKNOWN.md +18 -0
- package/docs/schema/URISchema.md +47 -0
- package/docs/schema/URISchemaOptions.md +33 -0
- package/docs/schema/URI_SCHEMA.md +12 -0
- package/docs/schema/URLSchema.md +49 -0
- package/docs/schema/URLSchemaOptions.md +35 -0
- package/docs/schema/URL_SCHEMA.md +12 -0
- package/docs/schema/USD_AMOUNT.md +12 -0
- package/docs/schema/UUID.md +12 -0
- package/docs/schema/UUIDSchema.md +39 -0
- package/docs/schema/UUIDSchemaOptions.md +29 -0
- package/docs/schema/VIDEO.md +12 -0
- package/docs/schema/VideoSchema.md +28 -0
- package/docs/schema.md +238 -0
- package/docs/sequence/DeferredErrorResult.md +20 -0
- package/docs/sequence/DeferredResult.md +17 -0
- package/docs/sequence/DeferredSequence/cancel.md +13 -0
- package/docs/sequence/DeferredSequence/catch.md +10 -0
- package/docs/sequence/DeferredSequence/done.md +13 -0
- package/docs/sequence/DeferredSequence/finally.md +10 -0
- package/docs/sequence/DeferredSequence/next.md +10 -0
- package/docs/sequence/DeferredSequence/reject.md +13 -0
- package/docs/sequence/DeferredSequence/resolve.md +13 -0
- package/docs/sequence/DeferredSequence/then.md +10 -0
- package/docs/sequence/DeferredSequence/through.md +13 -0
- package/docs/sequence/DeferredSequence.md +75 -0
- package/docs/sequence/InspectSequence.md +57 -0
- package/docs/sequence/LazySequence/start.md +14 -0
- package/docs/sequence/LazySequence/stop.md +14 -0
- package/docs/sequence/LazySequence.md +61 -0
- package/docs/sequence/Sequence/next.md +12 -0
- package/docs/sequence/Sequence/return.md +14 -0
- package/docs/sequence/Sequence/throw.md +14 -0
- package/docs/sequence/Sequence.md +53 -0
- package/docs/sequence/ThroughSequence/next.md +10 -0
- package/docs/sequence/ThroughSequence.md +57 -0
- package/docs/sequence.md +54 -0
- package/docs/store/ALWAYS_REFRESH.md +6 -0
- package/docs/store/AVOID_REFRESH.md +6 -0
- package/docs/store/AnyStore.md +16 -0
- package/docs/store/ArrayStore/add.md +13 -0
- package/docs/store/ArrayStore/delete.md +12 -0
- package/docs/store/ArrayStore/toggle.md +12 -0
- package/docs/store/ArrayStore.md +69 -0
- package/docs/store/AsyncStoreInput.md +18 -0
- package/docs/store/BooleanStore/toggle.md +12 -0
- package/docs/store/BooleanStore.md +46 -0
- package/docs/store/BusyStore.md +48 -0
- package/docs/store/DataStore/get.md +12 -0
- package/docs/store/DataStore/set.md +12 -0
- package/docs/store/DataStore/update.md +12 -0
- package/docs/store/DataStore.md +65 -0
- package/docs/store/DictionaryStore/delete.md +12 -0
- package/docs/store/DictionaryStore/deleteItems.md +12 -0
- package/docs/store/DictionaryStore/get.md +12 -0
- package/docs/store/DictionaryStore/set.md +12 -0
- package/docs/store/DictionaryStore/update.md +12 -0
- package/docs/store/DictionaryStore.md +63 -0
- package/docs/store/FetchCallback.md +20 -0
- package/docs/store/FetchStore/invalidate.md +13 -0
- package/docs/store/FetchStore/refresh.md +15 -0
- package/docs/store/FetchStore.md +67 -0
- package/docs/store/OptionalDataStore/delete.md +12 -0
- package/docs/store/OptionalDataStore/get.md +12 -0
- package/docs/store/OptionalDataStore/require.md +12 -0
- package/docs/store/OptionalDataStore/set.md +12 -0
- package/docs/store/OptionalDataStore/update.md +12 -0
- package/docs/store/OptionalDataStore.md +36 -0
- package/docs/store/PathStore/getPath.md +12 -0
- package/docs/store/PathStore/isActive.md +12 -0
- package/docs/store/PathStore/isProud.md +12 -0
- package/docs/store/PathStore.md +59 -0
- package/docs/store/PayloadFetchCallback.md +19 -0
- package/docs/store/PayloadFetchStore.md +62 -0
- package/docs/store/Store/abort.md +13 -0
- package/docs/store/Store/await.md +17 -0
- package/docs/store/Store/call.md +13 -0
- package/docs/store/Store/read.md +14 -0
- package/docs/store/Store/reduce.md +13 -0
- package/docs/store/Store/run.md +13 -0
- package/docs/store/Store/send.md +13 -0
- package/docs/store/Store/stale.md +12 -0
- package/docs/store/Store/subscribe.md +13 -0
- package/docs/store/Store/through.md +12 -0
- package/docs/store/Store/write.md +14 -0
- package/docs/store/Store.md +119 -0
- package/docs/store/StoreCallback.md +16 -0
- package/docs/store/StoreInput.md +13 -0
- package/docs/store/StoreInternal.md +13 -0
- package/docs/store/StoreReducer.md +16 -0
- package/docs/store/URLStore/clearParams.md +12 -0
- package/docs/store/URLStore/deleteParam.md +12 -0
- package/docs/store/URLStore/deleteParams.md +12 -0
- package/docs/store/URLStore/getParam.md +12 -0
- package/docs/store/URLStore/isActive.md +13 -0
- package/docs/store/URLStore/isProud.md +14 -0
- package/docs/store/URLStore/omitParam.md +12 -0
- package/docs/store/URLStore/omitParams.md +12 -0
- package/docs/store/URLStore/requireParam.md +12 -0
- package/docs/store/URLStore/setParam.md +12 -0
- package/docs/store/URLStore/setParams.md +12 -0
- package/docs/store/URLStore/updateParams.md +12 -0
- package/docs/store/URLStore/withParam.md +12 -0
- package/docs/store/URLStore/withParams.md +12 -0
- package/docs/store/URLStore.md +84 -0
- package/docs/store.md +84 -0
- package/docs/test/BASICS_COLLECTION.md +6 -0
- package/docs/test/BASIC_SCHEMA.md +6 -0
- package/docs/test/BasicData.md +16 -0
- package/docs/test/BasicItem.md +17 -0
- package/docs/test/EXPECT_PROMISELIKE.md +12 -0
- package/docs/test/PEOPLE_COLLECTION.md +6 -0
- package/docs/test/PERSON_SCHEMA.md +6 -0
- package/docs/test/PersonData.md +16 -0
- package/docs/test/PersonItem.md +17 -0
- package/docs/test/TestDBProviderOptions.md +24 -0
- package/docs/test/TransactionTestDBProvider.md +22 -0
- package/docs/test/basic1.md +12 -0
- package/docs/test/basic2.md +12 -0
- package/docs/test/basic3.md +12 -0
- package/docs/test/basic4.md +12 -0
- package/docs/test/basic5.md +12 -0
- package/docs/test/basic6.md +12 -0
- package/docs/test/basic7.md +12 -0
- package/docs/test/basic8.md +12 -0
- package/docs/test/basic9.md +12 -0
- package/docs/test/basic999.md +12 -0
- package/docs/test/basics.md +12 -0
- package/docs/test/expectOrderedItems.md +28 -0
- package/docs/test/expectUnorderedItems.md +28 -0
- package/docs/test/people.md +12 -0
- package/docs/test/person1.md +12 -0
- package/docs/test/person2.md +12 -0
- package/docs/test/person3.md +12 -0
- package/docs/test/person4.md +12 -0
- package/docs/test/person5.md +12 -0
- package/docs/test/testDBProvider.md +32 -0
- package/docs/test.md +107 -0
- package/docs/ui/Address.md +24 -0
- package/docs/ui/AddressProps.md +13 -0
- package/docs/ui/Ago.md +36 -0
- package/docs/ui/AgoProps.md +13 -0
- package/docs/ui/App.md +79 -0
- package/docs/ui/AppProps.md +13 -0
- package/docs/ui/ArrayCheckboxInputs.md +43 -0
- package/docs/ui/ArrayCheckboxInputsProps.md +23 -0
- package/docs/ui/ArrayInput.md +37 -0
- package/docs/ui/ArrayInputProps.md +29 -0
- package/docs/ui/ArrayRadioInputs.md +42 -0
- package/docs/ui/ArrayRadioInputsProps.md +23 -0
- package/docs/ui/ArraySchemaInput.md +30 -0
- package/docs/ui/ArraySchemaInputProps.md +13 -0
- package/docs/ui/Article.md +26 -0
- package/docs/ui/Block.md +32 -0
- package/docs/ui/BlockElement.md +12 -0
- package/docs/ui/BlockProps.md +21 -0
- package/docs/ui/BlockVariants.md +13 -0
- package/docs/ui/Blockquote.md +30 -0
- package/docs/ui/BlockquoteProps.md +13 -0
- package/docs/ui/BooleanSchemaInput.md +30 -0
- package/docs/ui/BooleanSchemaInputProps.md +13 -0
- package/docs/ui/Button.md +204 -0
- package/docs/ui/ButtonClickable.md +39 -0
- package/docs/ui/ButtonInput.md +31 -0
- package/docs/ui/ButtonInputProps.md +13 -0
- package/docs/ui/ButtonProps.md +13 -0
- package/docs/ui/ButtonVariants.md +31 -0
- package/docs/ui/CSSModule.md +16 -0
- package/docs/ui/Caption.md +30 -0
- package/docs/ui/CaptionProps.md +13 -0
- package/docs/ui/Card.md +118 -0
- package/docs/ui/CardProps.md +21 -0
- package/docs/ui/CaseVariant.md +12 -0
- package/docs/ui/Catcher/getDerivedStateFromError.md +10 -0
- package/docs/ui/Catcher.md +68 -0
- package/docs/ui/CatcherProps.md +21 -0
- package/docs/ui/Cell.md +29 -0
- package/docs/ui/CellProps.md +21 -0
- package/docs/ui/CenteredLayout.md +66 -0
- package/docs/ui/CenteredLayoutProps.md +14 -0
- package/docs/ui/CheckboxInput.md +43 -0
- package/docs/ui/CheckboxProps.md +13 -0
- package/docs/ui/ChildProps.md +20 -0
- package/docs/ui/ChoiceRadioInputs.md +35 -0
- package/docs/ui/ChoiceRadioInputsProps.md +25 -0
- package/docs/ui/ChoiceSchemaInput.md +33 -0
- package/docs/ui/ChoiceSchemaInputProps.md +13 -0
- package/docs/ui/ClassProps.md +79 -0
- package/docs/ui/Classes.md +21 -0
- package/docs/ui/Clickable.md +35 -0
- package/docs/ui/ClickableCallback.md +27 -0
- package/docs/ui/ClickableProps.md +35 -0
- package/docs/ui/Code.md +79 -0
- package/docs/ui/CodeProps.md +21 -0
- package/docs/ui/CollapseTransition.md +53 -0
- package/docs/ui/CollapseTransitionProps.md +13 -0
- package/docs/ui/ColorVariant.md +24 -0
- package/docs/ui/ColorVariants.md +20 -0
- package/docs/ui/Column.md +31 -0
- package/docs/ui/ColumnProps.md +21 -0
- package/docs/ui/ColumnsVariant.md +12 -0
- package/docs/ui/DataInput.md +32 -0
- package/docs/ui/DataInputProps.md +21 -0
- package/docs/ui/DataSchemaInput.md +30 -0
- package/docs/ui/DataSchemaInputProps.md +13 -0
- package/docs/ui/DateInput.md +50 -0
- package/docs/ui/DateInputProps.md +27 -0
- package/docs/ui/DateSchemaInput.md +30 -0
- package/docs/ui/DateSchemaInputProps.md +13 -0
- package/docs/ui/Definitions.md +32 -0
- package/docs/ui/DefinitionsProps.md +13 -0
- package/docs/ui/Deleted.md +63 -0
- package/docs/ui/DeletedProps.md +13 -0
- package/docs/ui/Details.md +93 -0
- package/docs/ui/DetailsProps.md +27 -0
- package/docs/ui/Dialog.md +96 -0
- package/docs/ui/DialogCloseButton.md +31 -0
- package/docs/ui/DialogCloseButtonProps.md +13 -0
- package/docs/ui/DialogProps.md +21 -0
- package/docs/ui/Dialogs.md +18 -0
- package/docs/ui/DialogsContext.md +24 -0
- package/docs/ui/DialogsContextProps.md +13 -0
- package/docs/ui/DialogsProps.md +14 -0
- package/docs/ui/DialogsStore/show.md +12 -0
- package/docs/ui/DialogsStore.md +26 -0
- package/docs/ui/DictionaryInput.md +37 -0
- package/docs/ui/DictionaryInputProps.md +29 -0
- package/docs/ui/DictionarySchemaInput.md +30 -0
- package/docs/ui/DictionarySchemaInputProps.md +13 -0
- package/docs/ui/Divider.md +24 -0
- package/docs/ui/DividerProps.md +13 -0
- package/docs/ui/DocumentationApp.md +29 -0
- package/docs/ui/DocumentationButtons.md +69 -0
- package/docs/ui/DocumentationButtonsProps.md +25 -0
- package/docs/ui/DocumentationCard.md +74 -0
- package/docs/ui/DocumentationDescription.md +38 -0
- package/docs/ui/DocumentationDescriptionProps.md +26 -0
- package/docs/ui/DocumentationKind.md +32 -0
- package/docs/ui/DocumentationKindProps.md +21 -0
- package/docs/ui/DocumentationPage.md +92 -0
- package/docs/ui/DocumentationParams.md +36 -0
- package/docs/ui/DocumentationParamsProps.md +20 -0
- package/docs/ui/DocumentationProperties.md +36 -0
- package/docs/ui/DocumentationPropertiesProps.md +20 -0
- package/docs/ui/DocumentationReferences.md +33 -0
- package/docs/ui/DocumentationReferencesProps.md +20 -0
- package/docs/ui/DocumentationReturns.md +34 -0
- package/docs/ui/DocumentationReturnsProps.md +20 -0
- package/docs/ui/DocumentationSearchPage.md +29 -0
- package/docs/ui/DocumentationSignatures.md +34 -0
- package/docs/ui/DocumentationSignaturesProps.md +20 -0
- package/docs/ui/DocumentationThrows.md +34 -0
- package/docs/ui/DocumentationThrowsProps.md +20 -0
- package/docs/ui/DocumentationType.md +32 -0
- package/docs/ui/DocumentationTypeProps.md +20 -0
- package/docs/ui/DurationValue.md +12 -0
- package/docs/ui/DurationVariants.md +20 -0
- package/docs/ui/EMPTY_LOADING.md +6 -0
- package/docs/ui/EmailAddress.md +33 -0
- package/docs/ui/EmailAddressProps.md +23 -0
- package/docs/ui/Emphasis.md +59 -0
- package/docs/ui/EmphasisProps.md +13 -0
- package/docs/ui/Empty.md +61 -0
- package/docs/ui/EmptyProps.md +13 -0
- package/docs/ui/ErrorNotice.md +27 -0
- package/docs/ui/ErrorPage.md +25 -0
- package/docs/ui/ErrorProps.md +20 -0
- package/docs/ui/FadeTransition.md +55 -0
- package/docs/ui/FadeTransitionProps.md +13 -0
- package/docs/ui/Field.md +81 -0
- package/docs/ui/FieldProps.md +27 -0
- package/docs/ui/Figure.md +26 -0
- package/docs/ui/FileInput.md +47 -0
- package/docs/ui/FileInputProps.md +23 -0
- package/docs/ui/FlexVariants.md +47 -0
- package/docs/ui/FontVariant.md +12 -0
- package/docs/ui/Footer.md +25 -0
- package/docs/ui/Form.md +133 -0
- package/docs/ui/FormCallback.md +24 -0
- package/docs/ui/FormContext.md +6 -0
- package/docs/ui/FormField.md +36 -0
- package/docs/ui/FormFields.md +24 -0
- package/docs/ui/FormFooter.md +33 -0
- package/docs/ui/FormFooterProps.md +21 -0
- package/docs/ui/FormInput.md +31 -0
- package/docs/ui/FormInputProps.md +13 -0
- package/docs/ui/FormInputs.md +24 -0
- package/docs/ui/FormMessage.md +30 -0
- package/docs/ui/FormNotice.md +30 -0
- package/docs/ui/FormNotify.md +25 -0
- package/docs/ui/FormProps.md +29 -0
- package/docs/ui/FormStore/publish.md +14 -0
- package/docs/ui/FormStore/requireSchema.md +12 -0
- package/docs/ui/FormStore/submit.md +13 -0
- package/docs/ui/FormStore.md +85 -0
- package/docs/ui/FullscreenButton.md +36 -0
- package/docs/ui/FullscreenButtonProps.md +21 -0
- package/docs/ui/GapVariants.md +20 -0
- package/docs/ui/Grid.md +74 -0
- package/docs/ui/GridProps.md +21 -0
- package/docs/ui/GridVariants.md +21 -0
- package/docs/ui/HTML.md +55 -0
- package/docs/ui/HTMLProps.md +13 -0
- package/docs/ui/Head.md +42 -0
- package/docs/ui/Header.md +25 -0
- package/docs/ui/Heading.md +89 -0
- package/docs/ui/HeadingProps.md +21 -0
- package/docs/ui/HorizontalTransition.md +67 -0
- package/docs/ui/HorizontalTransitionProps.md +13 -0
- package/docs/ui/Icon.md +57 -0
- package/docs/ui/IconProps.md +25 -0
- package/docs/ui/Image.md +32 -0
- package/docs/ui/ImageInput.md +92 -0
- package/docs/ui/ImageInputProps.md +23 -0
- package/docs/ui/ImageProps.md +23 -0
- package/docs/ui/IndentVariant.md +29 -0
- package/docs/ui/IndentVariants.md +20 -0
- package/docs/ui/InputProps.md +31 -0
- package/docs/ui/InputVariants.md +15 -0
- package/docs/ui/InputWrapper.md +25 -0
- package/docs/ui/InputWrapperProps.md +13 -0
- package/docs/ui/Inserted.md +63 -0
- package/docs/ui/InsertedProps.md +13 -0
- package/docs/ui/LOADING.md +8 -0
- package/docs/ui/LOADING_INPUT.md +6 -0
- package/docs/ui/LOADING_NOTICE.md +6 -0
- package/docs/ui/Label.md +32 -0
- package/docs/ui/LabelProps.md +13 -0
- package/docs/ui/Link.md +80 -0
- package/docs/ui/LinkClickable.md +42 -0
- package/docs/ui/LinkProps.md +21 -0
- package/docs/ui/List.md +70 -0
- package/docs/ui/ListProps.md +23 -0
- package/docs/ui/Loader.md +28 -0
- package/docs/ui/LoaderProps.md +21 -0
- package/docs/ui/Loading.md +71 -0
- package/docs/ui/MapperProps.md +21 -0
- package/docs/ui/Mapping.md +22 -0
- package/docs/ui/MappingProps.md +21 -0
- package/docs/ui/Mark.md +58 -0
- package/docs/ui/MarkProps.md +13 -0
- package/docs/ui/Markup.md +58 -0
- package/docs/ui/MarkupProps.md +21 -0
- package/docs/ui/Menu.md +76 -0
- package/docs/ui/MenuItem.md +102 -0
- package/docs/ui/MenuItemProps.md +23 -0
- package/docs/ui/MenuProps.md +21 -0
- package/docs/ui/Message.md +26 -0
- package/docs/ui/MessageProps.md +13 -0
- package/docs/ui/Meta.md +44 -0
- package/docs/ui/MetaAssets.md +17 -0
- package/docs/ui/MetaCSP.md +14 -0
- package/docs/ui/MetaContext.md +12 -0
- package/docs/ui/MetaLinks.md +17 -0
- package/docs/ui/MetaTags.md +16 -0
- package/docs/ui/MetaURL.md +27 -0
- package/docs/ui/Modal.md +144 -0
- package/docs/ui/ModalProps.md +13 -0
- package/docs/ui/ModalVariants.md +29 -0
- package/docs/ui/NOTICES.md +12 -0
- package/docs/ui/Navigation.md +90 -0
- package/docs/ui/NavigationContext.md +12 -0
- package/docs/ui/NavigationProps.md +13 -0
- package/docs/ui/NavigationStore/back.md +14 -0
- package/docs/ui/NavigationStore/forward.md +12 -0
- package/docs/ui/NavigationStore/redirect.md +12 -0
- package/docs/ui/NavigationStore.md +72 -0
- package/docs/ui/Notice.md +74 -0
- package/docs/ui/NoticeCallback.md +17 -0
- package/docs/ui/NoticeProps.md +21 -0
- package/docs/ui/NoticeStore/close.md +12 -0
- package/docs/ui/NoticeStore/show.md +12 -0
- package/docs/ui/NoticeStore.md +47 -0
- package/docs/ui/Notices.md +105 -0
- package/docs/ui/NoticesPosition.md +12 -0
- package/docs/ui/NoticesProps.md +21 -0
- package/docs/ui/NoticesStore/show.md +12 -0
- package/docs/ui/NoticesStore.md +31 -0
- package/docs/ui/NumberInput.md +48 -0
- package/docs/ui/NumberInputProps.md +25 -0
- package/docs/ui/NumberSchemaInput.md +30 -0
- package/docs/ui/NumberSchemaInputProps.md +13 -0
- package/docs/ui/OptionalChildProps.md +20 -0
- package/docs/ui/OutputInput.md +30 -0
- package/docs/ui/OutputInputProps.md +13 -0
- package/docs/ui/PaddingVariants.md +20 -0
- package/docs/ui/Page.md +61 -0
- package/docs/ui/PageCatcher.md +25 -0
- package/docs/ui/PageLoader.md +28 -0
- package/docs/ui/PageProps.md +13 -0
- package/docs/ui/Panel.md +74 -0
- package/docs/ui/PanelProps.md +21 -0
- package/docs/ui/Paragraph.md +64 -0
- package/docs/ui/ParagraphProps.md +13 -0
- package/docs/ui/PhysicalAddress.md +33 -0
- package/docs/ui/PhysicalAddressProps.md +23 -0
- package/docs/ui/Popover.md +43 -0
- package/docs/ui/PopoverButton.md +39 -0
- package/docs/ui/PopoverButtonInput.md +39 -0
- package/docs/ui/PopoverButtonInputProps.md +21 -0
- package/docs/ui/PopoverButtonProps.md +21 -0
- package/docs/ui/PopoverChildren.md +26 -0
- package/docs/ui/PopoverProps.md +25 -0
- package/docs/ui/PossibleMeta.md +33 -0
- package/docs/ui/PossibleMetaAssets.md +18 -0
- package/docs/ui/PossibleMetaLinks.md +18 -0
- package/docs/ui/Preformatted.md +33 -0
- package/docs/ui/PreformattedProps.md +21 -0
- package/docs/ui/Progress.md +120 -0
- package/docs/ui/ProgressProps.md +25 -0
- package/docs/ui/Prose.md +61 -0
- package/docs/ui/ProseProps.md +13 -0
- package/docs/ui/QueryCheckboxesInput.md +72 -0
- package/docs/ui/QueryCheckboxesInputProps.md +13 -0
- package/docs/ui/QueryInputBase.md +36 -0
- package/docs/ui/QueryInputBaseProps.md +29 -0
- package/docs/ui/QueryRadiosInput.md +76 -0
- package/docs/ui/QueryRadiosInputProps.md +13 -0
- package/docs/ui/RadioInput.md +43 -0
- package/docs/ui/RadioInputProps.md +13 -0
- package/docs/ui/RadiusVariant.md +12 -0
- package/docs/ui/RadiusVariants.md +20 -0
- package/docs/ui/RetryButton.md +27 -0
- package/docs/ui/RetryButtonProps.md +15 -0
- package/docs/ui/RetryContext.md +8 -0
- package/docs/ui/Route.md +21 -0
- package/docs/ui/RouteCache.md +66 -0
- package/docs/ui/RouteCacheProps.md +22 -0
- package/docs/ui/RouteComponent.md +18 -0
- package/docs/ui/RouteContext.md +6 -0
- package/docs/ui/RoutePath.md +56 -0
- package/docs/ui/RoutePathProps.md +22 -0
- package/docs/ui/RouteProps.md +18 -0
- package/docs/ui/RouteState.md +27 -0
- package/docs/ui/Router.md +179 -0
- package/docs/ui/RouterProps.md +23 -0
- package/docs/ui/Routes.md +23 -0
- package/docs/ui/Row.md +31 -0
- package/docs/ui/RowProps.md +21 -0
- package/docs/ui/STATUSES.md +12 -0
- package/docs/ui/SchemaField.md +25 -0
- package/docs/ui/SchemaFieldProps.md +13 -0
- package/docs/ui/SchemaInput.md +90 -0
- package/docs/ui/SchemaInputProps.md +21 -0
- package/docs/ui/Scroll.md +30 -0
- package/docs/ui/ScrollComponentProps.md +13 -0
- package/docs/ui/ScrollVariants.md +22 -0
- package/docs/ui/Section.md +74 -0
- package/docs/ui/SectionProps.md +21 -0
- package/docs/ui/SelectInput.md +32 -0
- package/docs/ui/SelectProps.md +21 -0
- package/docs/ui/ShadowVariant.md +12 -0
- package/docs/ui/ShadowVariants.md +20 -0
- package/docs/ui/SidebarLayout.md +82 -0
- package/docs/ui/SidebarLayoutProps.md +23 -0
- package/docs/ui/SizeVariant.md +29 -0
- package/docs/ui/Small.md +60 -0
- package/docs/ui/SmallProps.md +13 -0
- package/docs/ui/SpaceValue.md +31 -0
- package/docs/ui/SpaceVariants.md +20 -0
- package/docs/ui/Span.md +64 -0
- package/docs/ui/SpanClickable.md +34 -0
- package/docs/ui/SpanProps.md +13 -0
- package/docs/ui/Status.md +13 -0
- package/docs/ui/StatusVariants.md +20 -0
- package/docs/ui/StringSchemaInput.md +32 -0
- package/docs/ui/StringSchemaInputProps.md +13 -0
- package/docs/ui/StrokeVariant.md +12 -0
- package/docs/ui/StrokeVariants.md +20 -0
- package/docs/ui/Strong.md +55 -0
- package/docs/ui/StrongProps.md +13 -0
- package/docs/ui/StylableClickableProps.md +13 -0
- package/docs/ui/Subheading.md +75 -0
- package/docs/ui/SubheadingProps.md +16 -0
- package/docs/ui/SubmitButton.md +38 -0
- package/docs/ui/SubmitButtonProps.md +19 -0
- package/docs/ui/Subscript.md +30 -0
- package/docs/ui/SubscriptProps.md +13 -0
- package/docs/ui/Superscript.md +30 -0
- package/docs/ui/SuperscriptProps.md +13 -0
- package/docs/ui/TINT_CLASS.md +77 -0
- package/docs/ui/TREE_CODE_RULE.md +14 -0
- package/docs/ui/TREE_MARKUP_RULES.md +13 -0
- package/docs/ui/Table.md +133 -0
- package/docs/ui/TableProps.md +14 -0
- package/docs/ui/Tag.md +67 -0
- package/docs/ui/TagProps.md +13 -0
- package/docs/ui/TagVariants.md +13 -0
- package/docs/ui/TextFormatter.md +12 -0
- package/docs/ui/TextInput.md +50 -0
- package/docs/ui/TextInputProps.md +27 -0
- package/docs/ui/TextareaInput.md +50 -0
- package/docs/ui/TextareaInputProps.md +27 -0
- package/docs/ui/TintVariant.md +35 -0
- package/docs/ui/Title.md +74 -0
- package/docs/ui/TitleProps.md +16 -0
- package/docs/ui/Transition.md +112 -0
- package/docs/ui/TransitionClasses.md +27 -0
- package/docs/ui/TransitionProps.md +25 -0
- package/docs/ui/TransitionType.md +16 -0
- package/docs/ui/TransitionVariants.md +20 -0
- package/docs/ui/TreeApp.md +85 -0
- package/docs/ui/TreeAppProps.md +25 -0
- package/docs/ui/TreeBreadcrumbs.md +36 -0
- package/docs/ui/TreeBreadcrumbsProps.md +13 -0
- package/docs/ui/TreeButton.md +36 -0
- package/docs/ui/TreeButtonProps.md +23 -0
- package/docs/ui/TreeCard.md +37 -0
- package/docs/ui/TreeCards.md +34 -0
- package/docs/ui/TreeCardsProps.md +20 -0
- package/docs/ui/TreeContext.md +8 -0
- package/docs/ui/TreeLink.md +35 -0
- package/docs/ui/TreeLinkProps.md +21 -0
- package/docs/ui/TreeMarkup.md +52 -0
- package/docs/ui/TreeMenu.md +60 -0
- package/docs/ui/TreeMenuItem.md +40 -0
- package/docs/ui/TreeMenuProps.md +20 -0
- package/docs/ui/TreePage.md +40 -0
- package/docs/ui/TreeProvider.md +33 -0
- package/docs/ui/TreeRouter.md +42 -0
- package/docs/ui/TreeRouterProps.md +21 -0
- package/docs/ui/TreeSidebar.md +51 -0
- package/docs/ui/TreeSidebarProps.md +13 -0
- package/docs/ui/TypographyVariants.md +43 -0
- package/docs/ui/Until.md +36 -0
- package/docs/ui/UntilProps.md +13 -0
- package/docs/ui/ValueInputProps/onValue.md +12 -0
- package/docs/ui/ValueInputProps.md +26 -0
- package/docs/ui/Variants.md +20 -0
- package/docs/ui/VerticalTransition.md +64 -0
- package/docs/ui/VerticalTransitionProps.md +13 -0
- package/docs/ui/Video.md +32 -0
- package/docs/ui/VideoProps.md +13 -0
- package/docs/ui/WeightVariant.md +12 -0
- package/docs/ui/When.md +39 -0
- package/docs/ui/WhenProps.md +26 -0
- package/docs/ui/WidthVariant.md +35 -0
- package/docs/ui/WidthVariants.md +22 -0
- package/docs/ui/awaitNotified.md +26 -0
- package/docs/ui/awaitNotifiedElement.md +33 -0
- package/docs/ui/awaitNotifiedForm.md +32 -0
- package/docs/ui/callNotified.md +28 -0
- package/docs/ui/callNotifiedElement.md +35 -0
- package/docs/ui/callNotifiedForm.md +36 -0
- package/docs/ui/createMapper.md +29 -0
- package/docs/ui/createMeta.md +40 -0
- package/docs/ui/eventLoopFocus.md +26 -0
- package/docs/ui/eventPreventDefault.md +26 -0
- package/docs/ui/focusFirstFocusable.md +26 -0
- package/docs/ui/getBlockClass.md +32 -0
- package/docs/ui/getButtonClass.md +30 -0
- package/docs/ui/getClass.md +75 -0
- package/docs/ui/getColorClass.md +77 -0
- package/docs/ui/getDocumentationKindColor.md +31 -0
- package/docs/ui/getDurationClass.md +44 -0
- package/docs/ui/getFlexClass.md +44 -0
- package/docs/ui/getGapClass.md +31 -0
- package/docs/ui/getGridClass.md +55 -0
- package/docs/ui/getIndentClass.md +31 -0
- package/docs/ui/getInputClass.md +30 -0
- package/docs/ui/getModuleClass.md +26 -0
- package/docs/ui/getMostVisibleObserverEntry.md +32 -0
- package/docs/ui/getPaddingClass.md +31 -0
- package/docs/ui/getRadiusClass.md +48 -0
- package/docs/ui/getScrollClass.md +32 -0
- package/docs/ui/getShadowClass.md +49 -0
- package/docs/ui/getSpaceClass.md +61 -0
- package/docs/ui/getStatusClass.md +34 -0
- package/docs/ui/getStrokeClass.md +45 -0
- package/docs/ui/getTagClass.md +30 -0
- package/docs/ui/getTreeElement.md +36 -0
- package/docs/ui/getTypographyClass.md +113 -0
- package/docs/ui/getWidthClass.md +60 -0
- package/docs/ui/isSchemaRequired.md +30 -0
- package/docs/ui/joinMetaCSP.md +30 -0
- package/docs/ui/joinTitles.md +30 -0
- package/docs/ui/loopFocus.md +27 -0
- package/docs/ui/matchMenuElement.md +37 -0
- package/docs/ui/mergeMeta.md +57 -0
- package/docs/ui/mergeMetaAssets.md +36 -0
- package/docs/ui/mergeMetaLinks.md +36 -0
- package/docs/ui/mergeMetaTags.md +25 -0
- package/docs/ui/mergeMetaURL.md +36 -0
- package/docs/ui/notify.md +67 -0
- package/docs/ui/notifyError.md +19 -0
- package/docs/ui/notifySuccess.md +19 -0
- package/docs/ui/notifyThrown.md +22 -0
- package/docs/ui/notifyThrownForm.md +33 -0
- package/docs/ui/requireContext.md +59 -0
- package/docs/ui/requireDialogs.md +18 -0
- package/docs/ui/requireForm.md +36 -0
- package/docs/ui/requireMeta.md +39 -0
- package/docs/ui/requireMetaURL.md +45 -0
- package/docs/ui/requireNavigation.md +24 -0
- package/docs/ui/setTransitionType.md +24 -0
- package/docs/ui/splitType.md +26 -0
- package/docs/ui/subscribeNotices.md +27 -0
- package/docs/ui/useDebouncedCallback.md +34 -0
- package/docs/ui/useDebouncedState.md +33 -0
- package/docs/ui/useField.md +32 -0
- package/docs/ui/useRefresh.md +27 -0
- package/docs/ui/useScrollIntersect.md +34 -0
- package/docs/ui/useTransitionValue.md +28 -0
- package/docs/ui/useTreeMap.md +26 -0
- package/docs/ui.md +542 -0
- package/docs/util/ansi/ANSI_BLACK.md +6 -0
- package/docs/util/ansi/ANSI_BLUE.md +6 -0
- package/docs/util/ansi/ANSI_BOLD.md +6 -0
- package/docs/util/ansi/ANSI_CYAN.md +6 -0
- package/docs/util/ansi/ANSI_DEFAULT.md +6 -0
- package/docs/util/ansi/ANSI_DOWN.md +6 -0
- package/docs/util/ansi/ANSI_FAILURE.md +6 -0
- package/docs/util/ansi/ANSI_GREEN.md +6 -0
- package/docs/util/ansi/ANSI_INVERSE.md +6 -0
- package/docs/util/ansi/ANSI_ITALIC.md +6 -0
- package/docs/util/ansi/ANSI_LEFT.md +6 -0
- package/docs/util/ansi/ANSI_MAGENTA.md +6 -0
- package/docs/util/ansi/ANSI_RED.md +6 -0
- package/docs/util/ansi/ANSI_RESET.md +6 -0
- package/docs/util/ansi/ANSI_RIGHT.md +6 -0
- package/docs/util/ansi/ANSI_STRIKE.md +6 -0
- package/docs/util/ansi/ANSI_SUCCESS.md +6 -0
- package/docs/util/ansi/ANSI_UNDERLINE.md +6 -0
- package/docs/util/ansi/ANSI_UP.md +6 -0
- package/docs/util/ansi/ANSI_WAITING.md +6 -0
- package/docs/util/ansi/ANSI_WHITE.md +6 -0
- package/docs/util/ansi/ANSI_YELLOW.md +6 -0
- package/docs/util/ansi/ansiWrap.md +28 -0
- package/docs/util/ansi.md +73 -0
- package/docs/util/array/ArrayItem.md +12 -0
- package/docs/util/array/ImmutableArray.md +13 -0
- package/docs/util/array/MutableArray.md +13 -0
- package/docs/util/array/PossibleArray.md +17 -0
- package/docs/util/array/addArrayItem.md +26 -0
- package/docs/util/array/addArrayItems.md +20 -0
- package/docs/util/array/assertArray.md +71 -0
- package/docs/util/array/assertArrayItem.md +32 -0
- package/docs/util/array/countArray.md +30 -0
- package/docs/util/array/deleteArrayItem.md +12 -0
- package/docs/util/array/deleteArrayItems.md +19 -0
- package/docs/util/array/getArray.md +24 -0
- package/docs/util/array/getFirst.md +24 -0
- package/docs/util/array/getLast.md +24 -0
- package/docs/util/array/getNext.md +25 -0
- package/docs/util/array/getPrev.md +25 -0
- package/docs/util/array/getUniqueArray.md +24 -0
- package/docs/util/array/interleaveArray.md +29 -0
- package/docs/util/array/isArray.md +63 -0
- package/docs/util/array/isArrayItem.md +25 -0
- package/docs/util/array/limitArray.md +31 -0
- package/docs/util/array/omitArrayIndex.md +25 -0
- package/docs/util/array/omitArrayItem.md +18 -0
- package/docs/util/array/omitArrayItems.md +25 -0
- package/docs/util/array/pickArrayItem.md +18 -0
- package/docs/util/array/pickArrayItems.md +25 -0
- package/docs/util/array/requireArray.md +71 -0
- package/docs/util/array/requireFirst.md +31 -0
- package/docs/util/array/requireLast.md +31 -0
- package/docs/util/array/requireNext.md +32 -0
- package/docs/util/array/requirePrev.md +32 -0
- package/docs/util/array/shuffleArray.md +24 -0
- package/docs/util/array/toggleArrayItem.md +18 -0
- package/docs/util/array/toggleArrayItems.md +25 -0
- package/docs/util/array/withArrayIndex.md +26 -0
- package/docs/util/array/withArrayItem.md +18 -0
- package/docs/util/array/withArrayItems.md +25 -0
- package/docs/util/array.md +132 -0
- package/docs/util/async/BasePromise.md +27 -0
- package/docs/util/async/Deferred.md +30 -0
- package/docs/util/async/assertAsync.md +36 -0
- package/docs/util/async/assertNotAsync.md +36 -0
- package/docs/util/async/assertPromise.md +36 -0
- package/docs/util/async/awaitAbort.md +32 -0
- package/docs/util/async/awaitErrors.md +24 -0
- package/docs/util/async/awaitRace.md +33 -0
- package/docs/util/async/awaitValues.md +35 -0
- package/docs/util/async/createDeferred.md +19 -0
- package/docs/util/async/getDelay.md +24 -0
- package/docs/util/async/isAsync.md +24 -0
- package/docs/util/async/notAsync.md +24 -0
- package/docs/util/async/runMicrotasks.md +18 -0
- package/docs/util/async/throwAsync.md +30 -0
- package/docs/util/async.md +90 -0
- package/docs/util/base64/decodeBase64Bytes.md +30 -0
- package/docs/util/base64/decodeBase64String.md +30 -0
- package/docs/util/base64/decodeBase64URLBytes.md +30 -0
- package/docs/util/base64/decodeBase64URLString.md +30 -0
- package/docs/util/base64/encodeBase64.md +31 -0
- package/docs/util/base64/encodeBase64URL.md +31 -0
- package/docs/util/base64.md +57 -0
- package/docs/util/boolean/assertBoolean.md +31 -0
- package/docs/util/boolean/assertFalse.md +31 -0
- package/docs/util/boolean/assertFalsy.md +31 -0
- package/docs/util/boolean/assertTrue.md +31 -0
- package/docs/util/boolean/assertTruthy.md +31 -0
- package/docs/util/boolean/isBoolean.md +24 -0
- package/docs/util/boolean/isFalse.md +24 -0
- package/docs/util/boolean/isFalsey.md +24 -0
- package/docs/util/boolean/isTrue.md +24 -0
- package/docs/util/boolean/isTruthy.md +24 -0
- package/docs/util/boolean.md +47 -0
- package/docs/util/buffer/TypedArray.md +30 -0
- package/docs/util/buffer/isBuffer.md +24 -0
- package/docs/util/buffer/isBufferView.md +24 -0
- package/docs/util/buffer/isTypedArray.md +24 -0
- package/docs/util/buffer.md +35 -0
- package/docs/util/bytes/Bytes.md +17 -0
- package/docs/util/bytes/PossibleBytes.md +17 -0
- package/docs/util/bytes/assertBytes.md +33 -0
- package/docs/util/bytes/getBytes.md +29 -0
- package/docs/util/bytes/isBytes.md +24 -0
- package/docs/util/bytes/requireBytes.md +33 -0
- package/docs/util/bytes.md +50 -0
- package/docs/util/class/AnyConstructor.md +12 -0
- package/docs/util/class/Class.md +12 -0
- package/docs/util/class/Constructor.md +12 -0
- package/docs/util/class/assertInstance.md +31 -0
- package/docs/util/class/getGetter.md +25 -0
- package/docs/util/class/getSetter.md +25 -0
- package/docs/util/class/isConstructor.md +24 -0
- package/docs/util/class/isInstance.md +25 -0
- package/docs/util/class.md +52 -0
- package/docs/util/color/Color/from.md +12 -0
- package/docs/util/color/Color/toString.md +12 -0
- package/docs/util/color/Color.md +50 -0
- package/docs/util/color/HEX3_REGEXP.md +6 -0
- package/docs/util/color/HEX6_REGEXP.md +6 -0
- package/docs/util/color/PossibleColor.md +16 -0
- package/docs/util/color/assertColor.md +31 -0
- package/docs/util/color/getColor.md +24 -0
- package/docs/util/color/isColor.md +24 -0
- package/docs/util/color/requireColor.md +31 -0
- package/docs/util/color.md +78 -0
- package/docs/util/constants/ABORT.md +12 -0
- package/docs/util/constants/BILLION.md +6 -0
- package/docs/util/constants/DAY.md +6 -0
- package/docs/util/constants/DOWN.md +6 -0
- package/docs/util/constants/FAILURE.md +6 -0
- package/docs/util/constants/HOUR.md +6 -0
- package/docs/util/constants/HUNDRED_THOUSAND.md +6 -0
- package/docs/util/constants/LEFT.md +6 -0
- package/docs/util/constants/MILLION.md +6 -0
- package/docs/util/constants/MINUTE.md +6 -0
- package/docs/util/constants/MONTH.md +7 -0
- package/docs/util/constants/NBSP.md +6 -0
- package/docs/util/constants/NNBSP.md +6 -0
- package/docs/util/constants/NONE.md +12 -0
- package/docs/util/constants/RIGHT.md +6 -0
- package/docs/util/constants/SECOND.md +6 -0
- package/docs/util/constants/SKIP.md +12 -0
- package/docs/util/constants/SUCCESS.md +6 -0
- package/docs/util/constants/TEN_THOUSAND.md +6 -0
- package/docs/util/constants/THINSP.md +6 -0
- package/docs/util/constants/THOUSAND.md +6 -0
- package/docs/util/constants/TRILLION.md +6 -0
- package/docs/util/constants/UP.md +6 -0
- package/docs/util/constants/WAITING.md +6 -0
- package/docs/util/constants/WEEK.md +6 -0
- package/docs/util/constants/YEAR.md +7 -0
- package/docs/util/constants.md +93 -0
- package/docs/util/crypto/getRandomBytes.md +24 -0
- package/docs/util/crypto/hashPassword.md +31 -0
- package/docs/util/crypto/verifyPassword.md +25 -0
- package/docs/util/crypto.md +42 -0
- package/docs/util/currency/CURRENCY_CODES.md +12 -0
- package/docs/util/currency/CurrencyCode.md +12 -0
- package/docs/util/currency/getCurrencyCode.md +25 -0
- package/docs/util/currency/getCurrencyStep.md +32 -0
- package/docs/util/currency/getCurrencySymbol.md +31 -0
- package/docs/util/currency/requireCurrencyCode.md +31 -0
- package/docs/util/currency.md +54 -0
- package/docs/util/data/BranchData.md +18 -0
- package/docs/util/data/BranchDataPath.md +16 -0
- package/docs/util/data/BranchDataProp.md +32 -0
- package/docs/util/data/BranchDataSegments.md +22 -0
- package/docs/util/data/BranchDataValue.md +16 -0
- package/docs/util/data/Data.md +12 -0
- package/docs/util/data/DataKey.md +12 -0
- package/docs/util/data/DataProp.md +20 -0
- package/docs/util/data/DataValue.md +16 -0
- package/docs/util/data/FlatData.md +15 -0
- package/docs/util/data/LeafData.md +18 -0
- package/docs/util/data/LeafDataPath.md +16 -0
- package/docs/util/data/LeafDataProp.md +32 -0
- package/docs/util/data/LeafDataSegments.md +22 -0
- package/docs/util/data/LeafDataValue.md +16 -0
- package/docs/util/data/NestedData.md +19 -0
- package/docs/util/data/PartialData.md +16 -0
- package/docs/util/data/assertData.md +31 -0
- package/docs/util/data/assertDataProp.md +32 -0
- package/docs/util/data/getDataKeys.md +27 -0
- package/docs/util/data/getDataProp.md +33 -0
- package/docs/util/data/getDataProps.md +27 -0
- package/docs/util/data/isData.md +24 -0
- package/docs/util/data/isDataProp.md +25 -0
- package/docs/util/data/joinDataPath.md +31 -0
- package/docs/util/data/splitDataPath.md +31 -0
- package/docs/util/data.md +109 -0
- package/docs/util/date/DAYS.md +6 -0
- package/docs/util/date/Day.md +12 -0
- package/docs/util/date/PossibleDate.md +16 -0
- package/docs/util/date/addDays.md +26 -0
- package/docs/util/date/addHours.md +26 -0
- package/docs/util/date/addMilliseconds.md +32 -0
- package/docs/util/date/addMinutes.md +26 -0
- package/docs/util/date/addMonths.md +28 -0
- package/docs/util/date/addSeconds.md +32 -0
- package/docs/util/date/addWeeks.md +26 -0
- package/docs/util/date/addYears.md +27 -0
- package/docs/util/date/assertDate.md +31 -0
- package/docs/util/date/getDate.md +25 -0
- package/docs/util/date/getDateString.md +24 -0
- package/docs/util/date/getDateTimeString.md +24 -0
- package/docs/util/date/getDay.md +24 -0
- package/docs/util/date/getMidnight.md +31 -0
- package/docs/util/date/getMonday.md +31 -0
- package/docs/util/date/getMonthStart.md +31 -0
- package/docs/util/date/getNow.md +18 -0
- package/docs/util/date/getTimeString.md +24 -0
- package/docs/util/date/getTimestamp.md +24 -0
- package/docs/util/date/getToday.md +18 -0
- package/docs/util/date/getTomorrow.md +18 -0
- package/docs/util/date/getYesterday.md +18 -0
- package/docs/util/date/isDate.md +25 -0
- package/docs/util/date/requireDate.md +31 -0
- package/docs/util/date/requireDateString.md +25 -0
- package/docs/util/date/requireDateTimeString.md +31 -0
- package/docs/util/date/requireTimeString.md +25 -0
- package/docs/util/date/requireTimestamp.md +30 -0
- package/docs/util/date.md +126 -0
- package/docs/util/debug/debug.md +82 -0
- package/docs/util/debug/debugArray.md +27 -0
- package/docs/util/debug/debugFullRequest.md +26 -0
- package/docs/util/debug/debugFullResponse.md +27 -0
- package/docs/util/debug/debugHeaders.md +25 -0
- package/docs/util/debug/debugMap.md +27 -0
- package/docs/util/debug/debugObject.md +27 -0
- package/docs/util/debug/debugRequest.md +25 -0
- package/docs/util/debug/debugResponse.md +25 -0
- package/docs/util/debug/debugSet.md +27 -0
- package/docs/util/debug/debugString.md +25 -0
- package/docs/util/debug/indent.md +26 -0
- package/docs/util/debug.md +19 -0
- package/docs/util/dictionary/DictionaryItem.md +13 -0
- package/docs/util/dictionary/DictionaryValue.md +12 -0
- package/docs/util/dictionary/EMPTY_DICTIONARY.md +12 -0
- package/docs/util/dictionary/EmptyDictionary.md +12 -0
- package/docs/util/dictionary/ImmutableDictionary.md +13 -0
- package/docs/util/dictionary/MutableDictionary.md +13 -0
- package/docs/util/dictionary/PossibleDictionary.md +19 -0
- package/docs/util/dictionary/assertDictionary.md +31 -0
- package/docs/util/dictionary/assertDictionaryItem.md +32 -0
- package/docs/util/dictionary/deleteDictionaryItem.md +12 -0
- package/docs/util/dictionary/deleteDictionaryItems.md +12 -0
- package/docs/util/dictionary/getDictionaryItem.md +25 -0
- package/docs/util/dictionary/getDictionaryItems.md +27 -0
- package/docs/util/dictionary/isDictionary.md +24 -0
- package/docs/util/dictionary/isDictionaryItem.md +25 -0
- package/docs/util/dictionary/omitDictionaryItem.md +19 -0
- package/docs/util/dictionary/omitDictionaryItems.md +19 -0
- package/docs/util/dictionary/pickDictionaryItems.md +18 -0
- package/docs/util/dictionary/requireDictionary.md +25 -0
- package/docs/util/dictionary/requireDictionaryItem.md +32 -0
- package/docs/util/dictionary/setDictionaryItem.md +19 -0
- package/docs/util/dictionary/setDictionaryItems.md +13 -0
- package/docs/util/dictionary/withDictionaryItem.md +19 -0
- package/docs/util/dictionary/withDictionaryItems.md +19 -0
- package/docs/util/dictionary.md +103 -0
- package/docs/util/diff/SAME.md +13 -0
- package/docs/util/diff/deepDiff.md +29 -0
- package/docs/util/diff/deepDiffArray.md +26 -0
- package/docs/util/diff/deepDiffObject.md +28 -0
- package/docs/util/diff.md +68 -0
- package/docs/util/dispose/DisposableMap.md +24 -0
- package/docs/util/dispose/DisposableSet.md +23 -0
- package/docs/util/dispose/awaitDispose.md +38 -0
- package/docs/util/dispose/dispose.md +97 -0
- package/docs/util/dispose/isAsyncDisposable.md +24 -0
- package/docs/util/dispose/isDisposable.md +24 -0
- package/docs/util/dispose.md +16 -0
- package/docs/util/duration/DURATION_UNITS.md +6 -0
- package/docs/util/duration/DurationData.md +16 -0
- package/docs/util/duration/DurationUnitKey.md +16 -0
- package/docs/util/duration/formatAgo.md +38 -0
- package/docs/util/duration/formatDuration.md +25 -0
- package/docs/util/duration/formatUntil.md +37 -0
- package/docs/util/duration/formatWhen.md +38 -0
- package/docs/util/duration/getAgo.md +32 -0
- package/docs/util/duration/getBestDurationUnit.md +32 -0
- package/docs/util/duration/getDaysAgo.md +33 -0
- package/docs/util/duration/getDaysUntil.md +33 -0
- package/docs/util/duration/getDuration.md +32 -0
- package/docs/util/duration/getHoursAgo.md +33 -0
- package/docs/util/duration/getHoursUntil.md +33 -0
- package/docs/util/duration/getMilliseconds.md +32 -0
- package/docs/util/duration/getMillisecondsAgo.md +32 -0
- package/docs/util/duration/getMillisecondsUntil.md +32 -0
- package/docs/util/duration/getMinutesAgo.md +33 -0
- package/docs/util/duration/getMinutesUntil.md +33 -0
- package/docs/util/duration/getMonthsAgo.md +33 -0
- package/docs/util/duration/getMonthsUntil.md +33 -0
- package/docs/util/duration/getSecondsAgo.md +33 -0
- package/docs/util/duration/getSecondsUntil.md +33 -0
- package/docs/util/duration/getUntil.md +32 -0
- package/docs/util/duration/getWeeksAgo.md +33 -0
- package/docs/util/duration/getWeeksUntil.md +33 -0
- package/docs/util/duration/getYearsAgo.md +34 -0
- package/docs/util/duration/getYearsUntil.md +33 -0
- package/docs/util/duration/isFuture.md +32 -0
- package/docs/util/duration/isPast.md +32 -0
- package/docs/util/duration/isToday.md +32 -0
- package/docs/util/duration.md +106 -0
- package/docs/util/element/Element.md +31 -0
- package/docs/util/element/ElementProps.md +24 -0
- package/docs/util/element/Elements.md +17 -0
- package/docs/util/element/filterElements.md +25 -0
- package/docs/util/element/getElementText.md +25 -0
- package/docs/util/element/isElement.md +24 -0
- package/docs/util/element/isElements.md +24 -0
- package/docs/util/element/mergeElements.md +30 -0
- package/docs/util/element/queryElements.md +26 -0
- package/docs/util/element/walkElements.md +31 -0
- package/docs/util/element.md +59 -0
- package/docs/util/entity/EMPTY_ENTITY.md +12 -0
- package/docs/util/entity/EmptyEntity.md +12 -0
- package/docs/util/entity/Entity.md +12 -0
- package/docs/util/entity/EntityType.md +17 -0
- package/docs/util/entity/getEntity.md +30 -0
- package/docs/util/entity/requireEntity.md +35 -0
- package/docs/util/entity.md +50 -0
- package/docs/util/entry/Entry.md +14 -0
- package/docs/util/entry/EntryKey.md +17 -0
- package/docs/util/entry/EntryObject.md +17 -0
- package/docs/util/entry/EntryValue.md +17 -0
- package/docs/util/entry/getEntries.md +29 -0
- package/docs/util/entry/getEntryKey.md +24 -0
- package/docs/util/entry/getEntryKeys.md +24 -0
- package/docs/util/entry/getEntryValue.md +24 -0
- package/docs/util/entry/getEntryValues.md +24 -0
- package/docs/util/entry.md +62 -0
- package/docs/util/env/getEnv.md +24 -0
- package/docs/util/env/getEnvBoolean.md +26 -0
- package/docs/util/env/requireEnv.md +31 -0
- package/docs/util/env/requireEnvBoolean.md +31 -0
- package/docs/util/env.md +37 -0
- package/docs/util/equal/assertEqual.md +32 -0
- package/docs/util/equal/assertNot.md +32 -0
- package/docs/util/equal/isArrayEqual.md +26 -0
- package/docs/util/equal/isArrayWith.md +25 -0
- package/docs/util/equal/isDeepEqual.md +26 -0
- package/docs/util/equal/isEqual.md +25 -0
- package/docs/util/equal/isEqualGreater.md +25 -0
- package/docs/util/equal/isEqualLess.md +25 -0
- package/docs/util/equal/isGreater.md +25 -0
- package/docs/util/equal/isInArray.md +25 -0
- package/docs/util/equal/isLess.md +25 -0
- package/docs/util/equal/isMapEqual.md +26 -0
- package/docs/util/equal/isObjectEqual.md +28 -0
- package/docs/util/equal/isObjectMatch.md +28 -0
- package/docs/util/equal/isObjectWith.md +25 -0
- package/docs/util/equal/isShallowEqual.md +26 -0
- package/docs/util/equal/notArrayWith.md +25 -0
- package/docs/util/equal/notDeepEqual.md +25 -0
- package/docs/util/equal/notEqual.md +25 -0
- package/docs/util/equal/notInArray.md +25 -0
- package/docs/util/equal/notObjectWith.md +25 -0
- package/docs/util/equal/notShallowEqual.md +25 -0
- package/docs/util/equal.md +102 -0
- package/docs/util/error/PossibleMessage.md +12 -0
- package/docs/util/error/getMessage.md +24 -0
- package/docs/util/error/getNamedMessage.md +26 -0
- package/docs/util/error/isError.md +25 -0
- package/docs/util/error/joinMessage.md +27 -0
- package/docs/util/error/logError.md +24 -0
- package/docs/util/error/requireMessage.md +31 -0
- package/docs/util/error/splitMessage.md +33 -0
- package/docs/util/error.md +67 -0
- package/docs/util/file/FileCapture.md +14 -0
- package/docs/util/file/FileTypes.md +14 -0
- package/docs/util/file/IMAGE_TYPES.md +12 -0
- package/docs/util/file/MEDIA_TYPES.md +12 -0
- package/docs/util/file/VIDEO_TYPES.md +12 -0
- package/docs/util/file/getFileAccept.md +25 -0
- package/docs/util/file/getFileExtension.md +24 -0
- package/docs/util/file/requireFileExtension.md +31 -0
- package/docs/util/file/splitFileExtension.md +26 -0
- package/docs/util/file.md +49 -0
- package/docs/util/filter/Match.md +12 -0
- package/docs/util/filter/filterArray.md +27 -0
- package/docs/util/filter/filterItems.md +26 -0
- package/docs/util/filter/filterSequence.md +26 -0
- package/docs/util/filter.md +57 -0
- package/docs/util/focus/getFirstFocusable.md +25 -0
- package/docs/util/focus.md +25 -0
- package/docs/util/format/ArrayFormatOptions.md +13 -0
- package/docs/util/format/CurrencyFormatOptions.md +13 -0
- package/docs/util/format/DateFormatOptions.md +21 -0
- package/docs/util/format/FormatOptions.md +20 -0
- package/docs/util/format/NumberFormatOptions.md +13 -0
- package/docs/util/format/PercentFormatOptions.md +13 -0
- package/docs/util/format/UnitFormatOptions.md +25 -0
- package/docs/util/format/formatArray.md +26 -0
- package/docs/util/format/formatBoolean.md +24 -0
- package/docs/util/format/formatCurrency.md +33 -0
- package/docs/util/format/formatDate.md +33 -0
- package/docs/util/format/formatDateTime.md +33 -0
- package/docs/util/format/formatNumber.md +25 -0
- package/docs/util/format/formatObject.md +27 -0
- package/docs/util/format/formatPercent.md +29 -0
- package/docs/util/format/formatRange.md +26 -0
- package/docs/util/format/formatTime.md +33 -0
- package/docs/util/format/formatURI.md +33 -0
- package/docs/util/format/formatURL.md +33 -0
- package/docs/util/format/formatUnit.md +35 -0
- package/docs/util/format/formatUnitAbbr.md +41 -0
- package/docs/util/format/formatValue.md +37 -0
- package/docs/util/format/formatValues.md +33 -0
- package/docs/util/format.md +114 -0
- package/docs/util/function/AnyCaller.md +17 -0
- package/docs/util/function/AnyFunction.md +12 -0
- package/docs/util/function/Arguments.md +12 -0
- package/docs/util/function/BLACKHOLE.md +24 -0
- package/docs/util/function/Callback.md +12 -0
- package/docs/util/function/ErrorCallback.md +12 -0
- package/docs/util/function/PASSTHROUGH.md +24 -0
- package/docs/util/function/UnknownFunction.md +12 -0
- package/docs/util/function/ValueCallback.md +12 -0
- package/docs/util/function/assertFunction.md +30 -0
- package/docs/util/function/isFunction.md +24 -0
- package/docs/util/function.md +65 -0
- package/docs/util/geo/AddressData.md +34 -0
- package/docs/util/geo/COUNTRIES.md +7 -0
- package/docs/util/geo/Country.md +12 -0
- package/docs/util/geo/PossibleCountry.md +16 -0
- package/docs/util/geo/formatAddress.md +32 -0
- package/docs/util/geo/formatCountry.md +25 -0
- package/docs/util/geo/getCountry.md +26 -0
- package/docs/util/geo/requireCountry.md +31 -0
- package/docs/util/geo.md +74 -0
- package/docs/util/hash/hashString.md +26 -0
- package/docs/util/hash/hashStringBetween.md +27 -0
- package/docs/util/hash.md +29 -0
- package/docs/util/http/OptionalRequestHandler.md +18 -0
- package/docs/util/http/OptionalRequestHandlers.md +17 -0
- package/docs/util/http/RequestBodyMethod.md +12 -0
- package/docs/util/http/RequestHandler.md +18 -0
- package/docs/util/http/RequestHeadMethod.md +12 -0
- package/docs/util/http/RequestMethod.md +17 -0
- package/docs/util/http/RequestOptions.md +20 -0
- package/docs/util/http/RequestParams.md +16 -0
- package/docs/util/http/assertRequestHeadPayload.md +38 -0
- package/docs/util/http/createFormDataRequest.md +35 -0
- package/docs/util/http/createHeadRequest.md +29 -0
- package/docs/util/http/createJSONRequest.md +30 -0
- package/docs/util/http/createRequest.md +40 -0
- package/docs/util/http/createTextRequest.md +36 -0
- package/docs/util/http/createXMLRequest.md +42 -0
- package/docs/util/http/getErrorResponse.md +32 -0
- package/docs/util/http/getResponse.md +27 -0
- package/docs/util/http/isRequestHeadMethod.md +30 -0
- package/docs/util/http/isRequestMethod.md +30 -0
- package/docs/util/http/mergeRequestOptions.md +28 -0
- package/docs/util/http/parseRequestBody.md +34 -0
- package/docs/util/http/parseRequestFormData.md +37 -0
- package/docs/util/http/parseRequestJSON.md +31 -0
- package/docs/util/http/parseResponseBody.md +33 -0
- package/docs/util/http/parseResponseFormData.md +37 -0
- package/docs/util/http/parseResponseJSON.md +37 -0
- package/docs/util/http.md +104 -0
- package/docs/util/hydrate/DehydratedObject.md +22 -0
- package/docs/util/hydrate/Hydrations.md +18 -0
- package/docs/util/hydrate/dehydrate.md +35 -0
- package/docs/util/hydrate/hydrate.md +88 -0
- package/docs/util/hydrate.md +14 -0
- package/docs/util/index.md +4 -0
- package/docs/util/item/Identifier.md +12 -0
- package/docs/util/item/Item.md +12 -0
- package/docs/util/item/ItemSequence.md +17 -0
- package/docs/util/item/Items.md +17 -0
- package/docs/util/item/ItemsSequence.md +17 -0
- package/docs/util/item/OptionalItem.md +16 -0
- package/docs/util/item/OptionalItemSequence.md +17 -0
- package/docs/util/item/getIdentifier.md +24 -0
- package/docs/util/item/getIdentifiers.md +24 -0
- package/docs/util/item/getItem.md +26 -0
- package/docs/util/item/hasIdentifier.md +25 -0
- package/docs/util/item.md +68 -0
- package/docs/util/iterate/DeepIterable.md +17 -0
- package/docs/util/iterate/countItems.md +25 -0
- package/docs/util/iterate/flattenItems.md +24 -0
- package/docs/util/iterate/getChunks.md +26 -0
- package/docs/util/iterate/getRange.md +27 -0
- package/docs/util/iterate/hasItems.md +25 -0
- package/docs/util/iterate/interleaveItems.md +29 -0
- package/docs/util/iterate/isIterable.md +24 -0
- package/docs/util/iterate/limitItems.md +26 -0
- package/docs/util/iterate/mergeItems.md +25 -0
- package/docs/util/iterate/omitItems.md +26 -0
- package/docs/util/iterate/pickItems.md +26 -0
- package/docs/util/iterate/reduceItems.md +41 -0
- package/docs/util/iterate.md +84 -0
- package/docs/util/jwt/TokenClaims.md +26 -0
- package/docs/util/jwt/TokenData.md +35 -0
- package/docs/util/jwt/encodeToken.md +36 -0
- package/docs/util/jwt/getRequestToken.md +24 -0
- package/docs/util/jwt/requireRequestToken.md +31 -0
- package/docs/util/jwt/setRequestToken.md +25 -0
- package/docs/util/jwt/splitToken.md +32 -0
- package/docs/util/jwt/verifyRequestToken.md +33 -0
- package/docs/util/jwt/verifyToken.md +35 -0
- package/docs/util/jwt.md +78 -0
- package/docs/util/lazy/Lazy.md +12 -0
- package/docs/util/lazy/getLazy.md +37 -0
- package/docs/util/lazy.md +12 -0
- package/docs/util/link/PossibleLink.md +16 -0
- package/docs/util/link/getLink.md +43 -0
- package/docs/util/link/requireLink.md +41 -0
- package/docs/util/link.md +47 -0
- package/docs/util/log/logRequest.md +24 -0
- package/docs/util/log/logRequestError.md +25 -0
- package/docs/util/log/logRequestResponse.md +25 -0
- package/docs/util/log.md +28 -0
- package/docs/util/map/ImmutableMap.md +17 -0
- package/docs/util/map/MapItem.md +17 -0
- package/docs/util/map/MapKey.md +17 -0
- package/docs/util/map/MapValue.md +17 -0
- package/docs/util/map/MutableMap.md +16 -0
- package/docs/util/map/PossibleMap.md +18 -0
- package/docs/util/map/PossibleStringMap.md +16 -0
- package/docs/util/map/assertMap.md +31 -0
- package/docs/util/map/assertMapItem.md +32 -0
- package/docs/util/map/getMap.md +27 -0
- package/docs/util/map/getMapItem.md +25 -0
- package/docs/util/map/isMap.md +24 -0
- package/docs/util/map/isMapItem.md +25 -0
- package/docs/util/map/limitMap.md +26 -0
- package/docs/util/map/removeMapItems.md +25 -0
- package/docs/util/map/requireMapItem.md +32 -0
- package/docs/util/map/setMapItem.md +26 -0
- package/docs/util/map/setMapItems.md +25 -0
- package/docs/util/map.md +91 -0
- package/docs/util/merge/deepMerge.md +37 -0
- package/docs/util/merge/exactMerge.md +26 -0
- package/docs/util/merge/mergeArray.md +28 -0
- package/docs/util/merge/mergeObject.md +32 -0
- package/docs/util/merge/shallowMerge.md +37 -0
- package/docs/util/merge.md +67 -0
- package/docs/util/null/Nullable.md +12 -0
- package/docs/util/null/Nullish.md +12 -0
- package/docs/util/null/assertNotNull.md +31 -0
- package/docs/util/null/assertNotNullish.md +31 -0
- package/docs/util/null/assertNull.md +31 -0
- package/docs/util/null/assertNullish.md +31 -0
- package/docs/util/null/getNull.md +19 -0
- package/docs/util/null/isNull.md +24 -0
- package/docs/util/null/isNullish.md +24 -0
- package/docs/util/null/notNull.md +24 -0
- package/docs/util/null/notNullish.md +24 -0
- package/docs/util/null/requireNotNull.md +31 -0
- package/docs/util/null/requireNotNullish.md +31 -0
- package/docs/util/null.md +55 -0
- package/docs/util/number/PossibleNumber.md +16 -0
- package/docs/util/number/assertInteger.md +33 -0
- package/docs/util/number/assertNumber.md +33 -0
- package/docs/util/number/boundNumber.md +33 -0
- package/docs/util/number/getClosestNumber.md +25 -0
- package/docs/util/number/getInteger.md +31 -0
- package/docs/util/number/getNumber.md +32 -0
- package/docs/util/number/getPercent.md +25 -0
- package/docs/util/number/isBetween.md +26 -0
- package/docs/util/number/isInteger.md +26 -0
- package/docs/util/number/isNumber.md +26 -0
- package/docs/util/number/requireInteger.md +33 -0
- package/docs/util/number/requireNumber.md +33 -0
- package/docs/util/number/roundNumber.md +27 -0
- package/docs/util/number/roundStep.md +25 -0
- package/docs/util/number/sumNumbers.md +24 -0
- package/docs/util/number/truncateNumber.md +26 -0
- package/docs/util/number/wrapNumber.md +36 -0
- package/docs/util/number.md +91 -0
- package/docs/util/object/DeepMutable.md +19 -0
- package/docs/util/object/DeepPartial.md +19 -0
- package/docs/util/object/DeepReadonly.md +19 -0
- package/docs/util/object/ImmutableObject.md +12 -0
- package/docs/util/object/Key.md +12 -0
- package/docs/util/object/Mutable.md +18 -0
- package/docs/util/object/MutableObject.md +12 -0
- package/docs/util/object/OmitProps.md +17 -0
- package/docs/util/object/PickProps.md +17 -0
- package/docs/util/object/PossibleObject.md +18 -0
- package/docs/util/object/Prop.md +12 -0
- package/docs/util/object/Value.md +12 -0
- package/docs/util/object/assertObject.md +30 -0
- package/docs/util/object/assertPlainObject.md +30 -0
- package/docs/util/object/assertProp.md +31 -0
- package/docs/util/object/cloneObject.md +24 -0
- package/docs/util/object/cloneObjectWith.md +32 -0
- package/docs/util/object/deleteProp.md +12 -0
- package/docs/util/object/deleteProps.md +19 -0
- package/docs/util/object/fromProp.md +25 -0
- package/docs/util/object/getKeys.md +30 -0
- package/docs/util/object/getObject.md +25 -0
- package/docs/util/object/getProp.md +25 -0
- package/docs/util/object/getProps.md +30 -0
- package/docs/util/object/getPrototype.md +25 -0
- package/docs/util/object/isObject.md +24 -0
- package/docs/util/object/isPlainObject.md +25 -0
- package/docs/util/object/isProp.md +25 -0
- package/docs/util/object/omitProp.md +19 -0
- package/docs/util/object/omitProps.md +26 -0
- package/docs/util/object/pickProps.md +25 -0
- package/docs/util/object/setProp.md +27 -0
- package/docs/util/object/setProps.md +20 -0
- package/docs/util/object/withProp.md +27 -0
- package/docs/util/object/withProps.md +30 -0
- package/docs/util/object.md +140 -0
- package/docs/util/path/AbsolutePath.md +12 -0
- package/docs/util/path/Path.md +17 -0
- package/docs/util/path/PathPart.md +12 -0
- package/docs/util/path/PossiblePath.md +12 -0
- package/docs/util/path/RelativePath.md +12 -0
- package/docs/util/path/cleanPath.md +31 -0
- package/docs/util/path/getPath.md +28 -0
- package/docs/util/path/isAbsolutePath.md +24 -0
- package/docs/util/path/isPathActive.md +26 -0
- package/docs/util/path/isPathProud.md +26 -0
- package/docs/util/path/isRelativePath.md +24 -0
- package/docs/util/path/joinPath.md +31 -0
- package/docs/util/path/matchPathPrefix.md +34 -0
- package/docs/util/path/requirePath.md +34 -0
- package/docs/util/path/splitPath.md +25 -0
- package/docs/util/path.md +82 -0
- package/docs/util/query/Query.md +36 -0
- package/docs/util/query/QueryFilter.md +27 -0
- package/docs/util/query/QueryItems.md +28 -0
- package/docs/util/query/QueryOrder.md +26 -0
- package/docs/util/query/compareQueryItems.md +26 -0
- package/docs/util/query/filterQueryItems.md +27 -0
- package/docs/util/query/getQueryAfter.md +42 -0
- package/docs/util/query/getQueryBefore.md +42 -0
- package/docs/util/query/getQueryFilters.md +24 -0
- package/docs/util/query/getQueryItemsAfter.md +42 -0
- package/docs/util/query/getQueryLimit.md +24 -0
- package/docs/util/query/getQueryOrders.md +24 -0
- package/docs/util/query/limitQueryItems.md +25 -0
- package/docs/util/query/matchQueryItem.md +25 -0
- package/docs/util/query/queryItems.md +26 -0
- package/docs/util/query/queryWritableItems.md +26 -0
- package/docs/util/query/sortQueryItems.md +25 -0
- package/docs/util/query.md +137 -0
- package/docs/util/random/getRandom.md +25 -0
- package/docs/util/random/getRandomCharacter.md +24 -0
- package/docs/util/random/getRandomExcept.md +27 -0
- package/docs/util/random/getRandomItem.md +30 -0
- package/docs/util/random/getRandomKey.md +27 -0
- package/docs/util/random.md +47 -0
- package/docs/util/regexp/ALWAYS_REGEXP.md +6 -0
- package/docs/util/regexp/Matchable.md +17 -0
- package/docs/util/regexp/Matchables.md +18 -0
- package/docs/util/regexp/NEVER_REGEXP.md +6 -0
- package/docs/util/regexp/NamedRegExp/exec.md +10 -0
- package/docs/util/regexp/NamedRegExp.md +19 -0
- package/docs/util/regexp/NamedRegExpData.md +14 -0
- package/docs/util/regexp/NamedRegExpExecArray.md +21 -0
- package/docs/util/regexp/PossibleRegExp.md +17 -0
- package/docs/util/regexp/TypedRegExp/exec.md +10 -0
- package/docs/util/regexp/TypedRegExp.md +19 -0
- package/docs/util/regexp/TypedRegExpExecArray.md +15 -0
- package/docs/util/regexp/allMatch.md +25 -0
- package/docs/util/regexp/anyMatch.md +25 -0
- package/docs/util/regexp/assertRegExp.md +30 -0
- package/docs/util/regexp/createRegExpAll.md +26 -0
- package/docs/util/regexp/createRegExpAny.md +26 -0
- package/docs/util/regexp/escapeRegExp.md +25 -0
- package/docs/util/regexp/getMatch.md +32 -0
- package/docs/util/regexp/getMatchGroups.md +29 -0
- package/docs/util/regexp/getRegExp.md +30 -0
- package/docs/util/regexp/getRegExpSource.md +25 -0
- package/docs/util/regexp/isMatch.md +26 -0
- package/docs/util/regexp/isRegExp.md +24 -0
- package/docs/util/regexp/noneMatch.md +25 -0
- package/docs/util/regexp/notMatch.md +26 -0
- package/docs/util/regexp/requireMatch.md +38 -0
- package/docs/util/regexp/requireMatchGroups.md +35 -0
- package/docs/util/regexp.md +105 -0
- package/docs/util/sequence/IteratorAbortResult.md +23 -0
- package/docs/util/sequence/IteratorAbortableResult.md +18 -0
- package/docs/util/sequence/callSequence.md +26 -0
- package/docs/util/sequence/isSequence.md +25 -0
- package/docs/util/sequence/mergeSequences.md +25 -0
- package/docs/util/sequence/repeatDelay.md +24 -0
- package/docs/util/sequence/repeatUntil.md +32 -0
- package/docs/util/sequence/runSequence.md +38 -0
- package/docs/util/sequence.md +99 -0
- package/docs/util/serialise/serialise.md +81 -0
- package/docs/util/serialise.md +8 -0
- package/docs/util/set/ImmutableSet.md +16 -0
- package/docs/util/set/MutableSet.md +16 -0
- package/docs/util/set/PossibleSet.md +17 -0
- package/docs/util/set/SetItem.md +17 -0
- package/docs/util/set/addSetItem.md +26 -0
- package/docs/util/set/addSetItems.md +26 -0
- package/docs/util/set/assertSet.md +31 -0
- package/docs/util/set/assertSetItem.md +32 -0
- package/docs/util/set/deleteSetItems.md +26 -0
- package/docs/util/set/getSet.md +25 -0
- package/docs/util/set/isSet.md +24 -0
- package/docs/util/set/isSetItem.md +25 -0
- package/docs/util/set/limitSet.md +26 -0
- package/docs/util/set.md +81 -0
- package/docs/util/sort/Compare.md +13 -0
- package/docs/util/sort/compareAscending.md +34 -0
- package/docs/util/sort/compareDescending.md +26 -0
- package/docs/util/sort/sortArray.md +27 -0
- package/docs/util/sort.md +73 -0
- package/docs/util/source/Sourceable.md +20 -0
- package/docs/util/source/getSource.md +26 -0
- package/docs/util/source/requireSource.md +33 -0
- package/docs/util/source.md +48 -0
- package/docs/util/start/PossibleStarter.md +17 -0
- package/docs/util/start/STOPHOLE.md +13 -0
- package/docs/util/start/StartCallback.md +16 -0
- package/docs/util/start/Starter/start.md +13 -0
- package/docs/util/start/Starter/stop.md +13 -0
- package/docs/util/start/Starter.md +32 -0
- package/docs/util/start/StopCallback.md +12 -0
- package/docs/util/start/getStarter.md +25 -0
- package/docs/util/start.md +76 -0
- package/docs/util/string/NotString.md +25 -0
- package/docs/util/string/PossibleString.md +16 -0
- package/docs/util/string/Segments.md +12 -0
- package/docs/util/string/assertString.md +37 -0
- package/docs/util/string/assertStringLength.md +33 -0
- package/docs/util/string/getFirstLine.md +24 -0
- package/docs/util/string/getRef.md +24 -0
- package/docs/util/string/getSlug.md +24 -0
- package/docs/util/string/getString.md +25 -0
- package/docs/util/string/getWords.md +28 -0
- package/docs/util/string/isLowercaseLetter.md +24 -0
- package/docs/util/string/isNonEmptyString.md +24 -0
- package/docs/util/string/isString.md +24 -0
- package/docs/util/string/isStringBetween.md +26 -0
- package/docs/util/string/isStringLength.md +26 -0
- package/docs/util/string/isUppercaseLetter.md +24 -0
- package/docs/util/string/joinStrings.md +31 -0
- package/docs/util/string/limitString.md +28 -0
- package/docs/util/string/requireRef.md +37 -0
- package/docs/util/string/requireSlug.md +31 -0
- package/docs/util/string/requireString.md +37 -0
- package/docs/util/string/requireStringLength.md +39 -0
- package/docs/util/string/sanitizeMultilineText.md +31 -0
- package/docs/util/string/sanitizeText.md +28 -0
- package/docs/util/string/sanitizeWord.md +33 -0
- package/docs/util/string/simplifyString.md +33 -0
- package/docs/util/string/splitString.md +65 -0
- package/docs/util/string/trimString.md +30 -0
- package/docs/util/string.md +114 -0
- package/docs/util/template/TemplateMatches.md +16 -0
- package/docs/util/template/TemplatePlaceholders.md +16 -0
- package/docs/util/template/TemplateValues.md +23 -0
- package/docs/util/template/getPlaceholders.md +30 -0
- package/docs/util/template/matchPathTemplate.md +42 -0
- package/docs/util/template/matchPathTemplates.md +31 -0
- package/docs/util/template/matchTemplate.md +40 -0
- package/docs/util/template/matchTemplates.md +31 -0
- package/docs/util/template/renderPathTemplate.md +47 -0
- package/docs/util/template/renderTemplate.md +38 -0
- package/docs/util/template.md +94 -0
- package/docs/util/timeout/Timeout/clear.md +12 -0
- package/docs/util/timeout/Timeout/set.md +12 -0
- package/docs/util/timeout/Timeout.md +39 -0
- package/docs/util/timeout.md +43 -0
- package/docs/util/transform/Transforms.md +18 -0
- package/docs/util/transform/mapArray.md +26 -0
- package/docs/util/transform/mapDictionary.md +27 -0
- package/docs/util/transform/mapEntries.md +27 -0
- package/docs/util/transform/mapEntryValues.md +27 -0
- package/docs/util/transform/mapItems.md +26 -0
- package/docs/util/transform/mapProps.md +27 -0
- package/docs/util/transform/mapSequence.md +27 -0
- package/docs/util/transform/transformObject.md +40 -0
- package/docs/util/transform.md +85 -0
- package/docs/util/tree/DocumentationElement.md +22 -0
- package/docs/util/tree/DocumentationElementProps.md +46 -0
- package/docs/util/tree/DocumentationExample.md +20 -0
- package/docs/util/tree/DocumentationParam.md +30 -0
- package/docs/util/tree/DocumentationReturn.md +22 -0
- package/docs/util/tree/DocumentationThrow.md +22 -0
- package/docs/util/tree/SearchTreeOptions.md +22 -0
- package/docs/util/tree/TreeElement.md +26 -0
- package/docs/util/tree/TreeElementProps.md +33 -0
- package/docs/util/tree/TreeElements.md +17 -0
- package/docs/util/tree/flattenTree.md +35 -0
- package/docs/util/tree/searchTree.md +42 -0
- package/docs/util/tree.md +77 -0
- package/docs/util/types/Resolve.md +18 -0
- package/docs/util/types/UnionToIntersection.md +18 -0
- package/docs/util/types.md +9 -0
- package/docs/util/undefined/assertDefined.md +31 -0
- package/docs/util/undefined/getUndefined.md +20 -0
- package/docs/util/undefined/isDefined.md +24 -0
- package/docs/util/undefined/isUndefined.md +24 -0
- package/docs/util/undefined/notUndefined.md +6 -0
- package/docs/util/undefined/requireDefined.md +31 -0
- package/docs/util/undefined.md +42 -0
- package/docs/util/units/ANGLE_UNITS.md +6 -0
- package/docs/util/units/AREA_UNITS.md +6 -0
- package/docs/util/units/AngleUnitKey.md +14 -0
- package/docs/util/units/AreaUnitKey.md +14 -0
- package/docs/util/units/LENGTH_UNITS.md +6 -0
- package/docs/util/units/LengthUnitKey.md +14 -0
- package/docs/util/units/MASS_UNITS.md +6 -0
- package/docs/util/units/MassUnitKey.md +14 -0
- package/docs/util/units/PERCENT_UNITS.md +6 -0
- package/docs/util/units/POINT_UNITS.md +6 -0
- package/docs/util/units/PercentUnitKey.md +16 -0
- package/docs/util/units/PointUnitKey.md +16 -0
- package/docs/util/units/SPEED_UNITS.md +6 -0
- package/docs/util/units/SpeedUnitKey.md +14 -0
- package/docs/util/units/TEMPERATURE_UNITS.md +6 -0
- package/docs/util/units/TemperatureUnitKey.md +14 -0
- package/docs/util/units/Unit/format.md +14 -0
- package/docs/util/units/Unit/formatAbbr.md +14 -0
- package/docs/util/units/Unit/from.md +12 -0
- package/docs/util/units/Unit/to.md +12 -0
- package/docs/util/units/Unit.md +43 -0
- package/docs/util/units/UnitList/convert.md +12 -0
- package/docs/util/units/UnitList/require.md +12 -0
- package/docs/util/units/UnitList.md +39 -0
- package/docs/util/units/VOLUME_UNITS.md +6 -0
- package/docs/util/units/VolumeUnitKey.md +14 -0
- package/docs/util/units.md +91 -0
- package/docs/util/update/Update.md +22 -0
- package/docs/util/update/Updates.md +55 -0
- package/docs/util/update/getUpdates.md +32 -0
- package/docs/util/update/updateData.md +34 -0
- package/docs/util/update.md +78 -0
- package/docs/util/uri/HTTP_SCHEMES.md +12 -0
- package/docs/util/uri/ImmutableURI.md +49 -0
- package/docs/util/uri/ImmutableURIConstructor.md +17 -0
- package/docs/util/uri/PossibleURI.md +16 -0
- package/docs/util/uri/PossibleURIParams.md +18 -0
- package/docs/util/uri/URIHash.md +12 -0
- package/docs/util/uri/URIParams.md +16 -0
- package/docs/util/uri/URIScheme.md +12 -0
- package/docs/util/uri/URISchemes.md +17 -0
- package/docs/util/uri/URISearch.md +12 -0
- package/docs/util/uri/URIString.md +19 -0
- package/docs/util/uri/assertURI.md +31 -0
- package/docs/util/uri/clearURIParams.md +28 -0
- package/docs/util/uri/getURI.md +26 -0
- package/docs/util/uri/getURIParam.md +25 -0
- package/docs/util/uri/getURIParams.md +34 -0
- package/docs/util/uri/isURI.md +24 -0
- package/docs/util/uri/omitURIParam.md +12 -0
- package/docs/util/uri/omitURIParams.md +28 -0
- package/docs/util/uri/requireURI.md +31 -0
- package/docs/util/uri/requireURIParam.md +26 -0
- package/docs/util/uri/withURIParam.md +37 -0
- package/docs/util/uri/withURIParams.md +37 -0
- package/docs/util/uri.md +100 -0
- package/docs/util/url/BaseURL.md +21 -0
- package/docs/util/url/ImmutableURL.md +39 -0
- package/docs/util/url/ImmutableURLConstructor.md +19 -0
- package/docs/util/url/PossibleURL.md +16 -0
- package/docs/util/url/URLString.md +14 -0
- package/docs/util/url/assertURL.md +31 -0
- package/docs/util/url/getBaseURL.md +26 -0
- package/docs/util/url/getBasedURI.md +31 -0
- package/docs/util/url/getURL.md +26 -0
- package/docs/util/url/isBaseURL.md +25 -0
- package/docs/util/url/isURL.md +25 -0
- package/docs/util/url/isURLActive.md +28 -0
- package/docs/util/url/isURLProud.md +29 -0
- package/docs/util/url/matchURLPrefix.md +37 -0
- package/docs/util/url/requireBaseURL.md +31 -0
- package/docs/util/url/requireURL.md +32 -0
- package/docs/util/url.md +98 -0
- package/docs/util/uuid/getUUID.md +28 -0
- package/docs/util/uuid/randomUUID.md +18 -0
- package/docs/util/uuid/requireUUID.md +30 -0
- package/docs/util/uuid.md +37 -0
- package/docs/util/validate/Validator/validate.md +12 -0
- package/docs/util/validate/Validator.md +18 -0
- package/docs/util/validate/ValidatorType.md +17 -0
- package/docs/util/validate/Validators.md +17 -0
- package/docs/util/validate/ValidatorsType.md +17 -0
- package/docs/util/validate/getValid.md +33 -0
- package/docs/util/validate/requireValid.md +35 -0
- package/docs/util/validate/validateArray.md +33 -0
- package/docs/util/validate/validateData.md +36 -0
- package/docs/util/validate/validateDictionary.md +33 -0
- package/docs/util/validate/validateItems.md +41 -0
- package/docs/util/validate.md +88 -0
- package/docs/util/xml/escapeXML.md +26 -0
- package/docs/util/xml/getXML.md +36 -0
- package/docs/util/xml.md +41 -0
- package/package.json +5 -4
- package/skills/shelving/SKILL.md +32 -0
- package/util/string.d.ts +9 -4
- package/util/string.js +31 -6
package/README.md
CHANGED
|
@@ -12,6 +12,19 @@ Full documentation is published at **<https://shelving.cc/>**.
|
|
|
12
12
|
npm install shelving
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
+
## For AI agents
|
|
16
|
+
|
|
17
|
+
The docs are also published as Markdown for LLMs and coding agents:
|
|
18
|
+
|
|
19
|
+
- <https://shelving.cc/llms.txt> is the index. <https://shelving.cc/llms-full.txt> has every page in one file.
|
|
20
|
+
- Add `.md` to any docs page path to get that page as Markdown, for example <https://shelving.cc/schema/StringSchema.md>.
|
|
21
|
+
- The npm package includes the same files in `node_modules/shelving/docs/`, so an agent can read the docs for the installed version without network access.
|
|
22
|
+
- The npm package also includes an [Agent Skill](https://agentskills.io/) at `node_modules/shelving/skills/shelving/SKILL.md`. It tells an agent where the docs are and which conventions to follow. To use it with Claude Code, link it into your project:
|
|
23
|
+
|
|
24
|
+
```sh
|
|
25
|
+
mkdir -p .claude/skills && ln -s ../../node_modules/shelving/skills/shelving .claude/skills/shelving
|
|
26
|
+
```
|
|
27
|
+
|
|
15
28
|
## Changelog
|
|
16
29
|
|
|
17
30
|
See [Releases](https://github.com/dhoulb/shelving/releases).
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# APICache.call()
|
|
2
|
+
|
|
3
|
+
- Kind: method
|
|
4
|
+
- Member of: `APICache`
|
|
5
|
+
|
|
6
|
+
Fetch (or return a cached result) for the given endpoint and payload.
|
|
7
|
+
- Returns the cached value immediately if one exists.
|
|
8
|
+
- Waits for the in-flight fetch if the store is loading.
|
|
9
|
+
- Throws if the fetch fails, matching `APIProvider.call` behaviour.
|
|
10
|
+
|
|
11
|
+
## Signatures
|
|
12
|
+
|
|
13
|
+
```ts
|
|
14
|
+
call(endpoint: Endpoint<PP, RR>, payload: PP, maxAge: number = AVOID_REFRESH, caller: AnyCaller = this.call): Promise<RR>
|
|
15
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# APICache.get()
|
|
2
|
+
|
|
3
|
+
- Kind: method
|
|
4
|
+
- Member of: `APICache`
|
|
5
|
+
|
|
6
|
+
Get (or create) the `EndpointCache` for the given endpoint.
|
|
7
|
+
|
|
8
|
+
## Signatures
|
|
9
|
+
|
|
10
|
+
```ts
|
|
11
|
+
get(endpoint: Endpoint<PP, RR>): EndpointCache<PP, RR>
|
|
12
|
+
get(endpoint: Endpoint): EndpointCache
|
|
13
|
+
```
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# APICache
|
|
2
|
+
|
|
3
|
+
- Kind: class
|
|
4
|
+
- Import: `import { APICache } from "shelving/api";`
|
|
5
|
+
- Implements: `AsyncDisposable`
|
|
6
|
+
|
|
7
|
+
Cache of `EndpointCache` objects keyed by `Endpoint`, providing memoised API results across many endpoints.
|
|
8
|
+
- Use `get(endpoint)` to retrieve or create the `EndpointCache` for a given endpoint, then `get(payload)` on that to get a specific `EndpointStore`.
|
|
9
|
+
- Disposing the cache disposes every nested `EndpointCache` and clears the map.
|
|
10
|
+
|
|
11
|
+
## Signatures
|
|
12
|
+
|
|
13
|
+
```ts
|
|
14
|
+
new APICache<P, R>(provider: APIProvider<P, R>)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
|
|
19
|
+
| Param | Type | Description |
|
|
20
|
+
| --- | --- | --- |
|
|
21
|
+
| `provider` | `APIProvider<P, R>` | |
|
|
22
|
+
|
|
23
|
+
## Returns
|
|
24
|
+
|
|
25
|
+
| Type | Description |
|
|
26
|
+
| --- | --- |
|
|
27
|
+
| `APICache<P, R>` | |
|
|
28
|
+
|
|
29
|
+
## Properties
|
|
30
|
+
|
|
31
|
+
| Property | Type | Description |
|
|
32
|
+
| --- | --- | --- |
|
|
33
|
+
| `provider` | `APIProvider<P, R>` | The underlying `APIProvider` that backs every cached endpoint. Read only. |
|
|
34
|
+
|
|
35
|
+
## Examples
|
|
36
|
+
|
|
37
|
+
```ts
|
|
38
|
+
const cache = new APICache(provider);
|
|
39
|
+
const user = await cache.call(getUser, { id: "abc" });
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## Methods
|
|
43
|
+
|
|
44
|
+
- [get](APICache/get.md): Get (or create) the EndpointCache for the given endpoint.
|
|
45
|
+
- [call](APICache/call.md): Fetch (or return a cached result) for the given endpoint and payload.
|
|
46
|
+
- [invalidate](APICache/invalidate.md): Invalidate a specific store for an endpoint so the next read refetches.
|
|
47
|
+
- [invalidateAll](APICache/invalidateAll.md): Invalidate all stores for an endpoint so the next read of any payload refetches.
|
|
48
|
+
- [refresh](APICache/refresh.md): Trigger a refetch on a specific store for an endpoint.
|
|
49
|
+
- [refreshAll](APICache/refreshAll.md): Trigger a refetch on all stores for an endpoint.
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# APIProvider.call()
|
|
2
|
+
|
|
3
|
+
- Kind: method
|
|
4
|
+
- Member of: `APIProvider`
|
|
5
|
+
|
|
6
|
+
Send a payload to an `Endpoint` and retrieve the parsed result.
|
|
7
|
+
- Composes `createRequest()`, `fetch()`, and `parseResponse()` into a single round trip.
|
|
8
|
+
|
|
9
|
+
## Signatures
|
|
10
|
+
|
|
11
|
+
```ts
|
|
12
|
+
call(endpoint: Endpoint<PP, RR>, payload: PP, options?: RequestOptions, caller?: AnyCaller): Promise<RR>
|
|
13
|
+
```
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# APIProvider.createRequest()
|
|
2
|
+
|
|
3
|
+
- Kind: method
|
|
4
|
+
- Member of: `APIProvider`
|
|
5
|
+
|
|
6
|
+
Create a `Request` that targets this endpoint with a given base URL.
|
|
7
|
+
|
|
8
|
+
## Signatures
|
|
9
|
+
|
|
10
|
+
```ts
|
|
11
|
+
createRequest(endpoint: Endpoint<PP, RR>, payload: PP, options?: RequestOptions, caller?: AnyCaller): Request
|
|
12
|
+
```
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# APIProvider.parseResponse()
|
|
2
|
+
|
|
3
|
+
- Kind: method
|
|
4
|
+
- Member of: `APIProvider`
|
|
5
|
+
|
|
6
|
+
Parse an HTTP `Response` for this endpoint into a result value.
|
|
7
|
+
- Non-2xx responses become `ResponseError`.
|
|
8
|
+
- Does not validate the result against the endpoint schema — use `ValidationAPIProvider` for that.
|
|
9
|
+
|
|
10
|
+
## Signatures
|
|
11
|
+
|
|
12
|
+
```ts
|
|
13
|
+
parseResponse(_endpoint: Endpoint<PP, RR>, response: Response, caller?: AnyCaller): Promise<RR>
|
|
14
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# APIProvider.renderURL()
|
|
2
|
+
|
|
3
|
+
- Kind: method
|
|
4
|
+
- Member of: `APIProvider`
|
|
5
|
+
|
|
6
|
+
Render the full final URL for an API request to a given endpoint with a given payload.
|
|
7
|
+
- Includes `?query` params if this is a `HEAD` or `GET` request.
|
|
8
|
+
|
|
9
|
+
## Signatures
|
|
10
|
+
|
|
11
|
+
```ts
|
|
12
|
+
renderURL(endpoint: Endpoint<PP, RR>, payload: PP, caller?: AnyCaller): URL
|
|
13
|
+
```
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# APIProvider
|
|
2
|
+
|
|
3
|
+
- Kind: class
|
|
4
|
+
- Import: `import { APIProvider } from "shelving/api";`
|
|
5
|
+
- Implements: `AsyncDisposable`
|
|
6
|
+
|
|
7
|
+
Abstract base for API providers that send requests to a set of `Endpoint` definitions rooted at a common base URL.
|
|
8
|
+
- Concrete subclasses implement `renderURL()`, `createRequest()`, `fetch()`, and `parseResponse()`; `call()` orchestrates them.
|
|
9
|
+
- Implements `AsyncDisposable` so providers can be wrapped and disposed in a chain.
|
|
10
|
+
|
|
11
|
+
The abstract base class every API provider implements. `APIProvider<P, R>` defines the surface that endpoint calls go through: `call(endpoint, payload)` to execute a typed endpoint, and `fetch(request)` as the lower-level transport step that wrapper providers intercept.
|
|
12
|
+
|
|
13
|
+
You never instantiate `APIProvider` directly — use the concrete `ClientAPIProvider` (or a mock), optionally wrapped in `ThroughAPIProvider` subclasses. `APIProvider` implements `AsyncDisposable`.
|
|
14
|
+
|
|
15
|
+
## Usage
|
|
16
|
+
|
|
17
|
+
Code that accepts "any provider" should type against `APIProvider` so a bare client, a validated chain, or a mock are all interchangeable:
|
|
18
|
+
|
|
19
|
+
```ts
|
|
20
|
+
import type { APIProvider } from "shelving/api"
|
|
21
|
+
|
|
22
|
+
async function loadUser(provider: APIProvider, id: string) {
|
|
23
|
+
return provider.call(getUser, { id }); // works with any provider in the chain
|
|
24
|
+
}
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
## Signatures
|
|
29
|
+
|
|
30
|
+
```ts
|
|
31
|
+
new APIProvider<P, R>()
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Returns
|
|
35
|
+
|
|
36
|
+
| Type | Description |
|
|
37
|
+
| --- | --- |
|
|
38
|
+
| `APIProvider<P, R>` | |
|
|
39
|
+
|
|
40
|
+
## Properties
|
|
41
|
+
|
|
42
|
+
| Property | Type | Description |
|
|
43
|
+
| --- | --- | --- |
|
|
44
|
+
| `url` | `URL` | The common base URL that every endpoint request is resolved against. Read only. |
|
|
45
|
+
|
|
46
|
+
## Methods
|
|
47
|
+
|
|
48
|
+
- [renderURL](APIProvider/renderURL.md): Render the full final URL for an API request to a given endpoint with a given payload.
|
|
49
|
+
- [createRequest](APIProvider/createRequest.md): Create a Request that targets this endpoint with a given base URL.
|
|
50
|
+
- [fetch](APIProvider/fetch.md): Send a Request and return its Response (defaults to the JavaScript fetch() API).
|
|
51
|
+
- [parseResponse](APIProvider/parseResponse.md): Parse an HTTP Response for this endpoint into a result value.
|
|
52
|
+
- [call](APIProvider/call.md): Send a payload to an Endpoint and retrieve the parsed result.
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# AnyEndpoint
|
|
2
|
+
|
|
3
|
+
- Kind: type
|
|
4
|
+
- Import: `import { AnyEndpoint } from "shelving/api";`
|
|
5
|
+
|
|
6
|
+
An `Endpoint` with any payload and result type, for use where the specific types don't matter.
|
|
7
|
+
|
|
8
|
+
## Signatures
|
|
9
|
+
|
|
10
|
+
```ts
|
|
11
|
+
Endpoint<any, any>
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Types
|
|
15
|
+
|
|
16
|
+
- [Endpoint](Endpoint.md): A typed API resource definition pairing a method and path with payload and result schemas.
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# AnyEndpointHandler
|
|
2
|
+
|
|
3
|
+
- Kind: type
|
|
4
|
+
- Import: `import { AnyEndpointHandler } from "shelving/api";`
|
|
5
|
+
|
|
6
|
+
An `EndpointHandler` with any payload and result type, for use where the specific types don't matter.
|
|
7
|
+
|
|
8
|
+
## Signatures
|
|
9
|
+
|
|
10
|
+
```ts
|
|
11
|
+
EndpointHandler<any, any, C>
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Types
|
|
15
|
+
|
|
16
|
+
- [EndpointHandler](EndpointHandler.md): A typed endpoint definition paired with its implementation callback.
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# CachedAPIProvider
|
|
2
|
+
|
|
3
|
+
- Kind: class
|
|
4
|
+
- Import: `import { CachedAPIProvider } from "shelving/api";`
|
|
5
|
+
- Extends: `ThroughAPIProvider<P, R>`
|
|
6
|
+
- Implements: `AsyncDisposable`
|
|
7
|
+
|
|
8
|
+
API provider wrapper that serves requests through an `APICache` so repeated calls reuse cached results.
|
|
9
|
+
- On `call(...)`, triggers `cache.refresh(maxAge)` for the endpoint+payload before awaiting `cache.call(...)`.
|
|
10
|
+
- `invalidate`, `invalidateAll`, `refresh`, and `refreshAll` pass through to the underlying cache and use `this.maxAge` as the default refresh timing.
|
|
11
|
+
|
|
12
|
+
A wrapping provider that serves calls through an `APICache`. Repeated calls for the same endpoint and payload skip the network and return the cached value, and it exposes `invalidate` / `refresh` helpers for cache control.
|
|
13
|
+
|
|
14
|
+
The constructor takes the `source` provider and an optional default `maxAge` (defaults to `AVOID_REFRESH` — only refetch when a value is missing or invalidated).
|
|
15
|
+
|
|
16
|
+
## Usage
|
|
17
|
+
|
|
18
|
+
```ts
|
|
19
|
+
import { CachedAPIProvider, ValidationAPIProvider, ClientAPIProvider } from "shelving/api"
|
|
20
|
+
|
|
21
|
+
const provider = new CachedAPIProvider(
|
|
22
|
+
new ValidationAPIProvider(new ClientAPIProvider({ url: "https://api.example.com" }))
|
|
23
|
+
)
|
|
24
|
+
|
|
25
|
+
await provider.call(getUser, { id: "u_1" }) // fetches
|
|
26
|
+
await provider.call(getUser, { id: "u_1" }) // returns cached
|
|
27
|
+
|
|
28
|
+
provider.invalidate(getUser, { id: "u_1" }) // mark stale
|
|
29
|
+
provider.refresh(getUser, { id: "u_1" }) // re-fetch eagerly
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
`invalidateAll(endpoint)` and `refreshAll(endpoint)` act on every cached payload for an endpoint at once.
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
## Signatures
|
|
36
|
+
|
|
37
|
+
```ts
|
|
38
|
+
new CachedAPIProvider<P, R>(source: APIProvider<P, R>, maxAge: number = AVOID_REFRESH)
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Parameters
|
|
42
|
+
|
|
43
|
+
| Param | Type | Description |
|
|
44
|
+
| --- | --- | --- |
|
|
45
|
+
| `source` | `APIProvider<P, R>` | |
|
|
46
|
+
| `maxAge` | `number` | Defaults to `AVOID_REFRESH`. |
|
|
47
|
+
|
|
48
|
+
## Returns
|
|
49
|
+
|
|
50
|
+
| Type | Description |
|
|
51
|
+
| --- | --- |
|
|
52
|
+
| `CachedAPIProvider<P, R>` | |
|
|
53
|
+
|
|
54
|
+
## Properties
|
|
55
|
+
|
|
56
|
+
| Property | Type | Description |
|
|
57
|
+
| --- | --- | --- |
|
|
58
|
+
| `maxAge` | `number \| undefined` | The maximum age used when calling `call()`, defaulting to `AVOID_REFRESH` (only refresh if invalidated or still loading). - Not used for `refresh()` calls, which always refetch immediately. Read only. |
|
|
59
|
+
|
|
60
|
+
## Methods
|
|
61
|
+
|
|
62
|
+
- [invalidate](CachedAPIProvider/invalidate.md): Invalidate the cached result for a specific endpoint and payload.
|
|
63
|
+
- [invalidateAll](CachedAPIProvider/invalidateAll.md): Invalidate every cached result for an endpoint, across all payloads.
|
|
64
|
+
- [refresh](CachedAPIProvider/refresh.md): Refresh the cached result for a specific endpoint and payload.
|
|
65
|
+
- [refreshAll](CachedAPIProvider/refreshAll.md): Refresh every cached result for an endpoint, across all payloads.
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# ClientAPIProvider
|
|
2
|
+
|
|
3
|
+
- Kind: class
|
|
4
|
+
- Import: `import { ClientAPIProvider } from "shelving/api";`
|
|
5
|
+
- Extends: `APIProvider<P, R>`
|
|
6
|
+
|
|
7
|
+
A client-side API provider that sends requests over the network using `fetch()`.
|
|
8
|
+
- Can be used on a server environment to make outgoing API calls, or in a browser environment to call a server API.
|
|
9
|
+
- Renders endpoint paths and query params into the URL and sends body payloads as JSON.
|
|
10
|
+
- Parses JSON responses and throws `ResponseError` for non-2xx responses.
|
|
11
|
+
- Extendable with custom request-building and response-parsing logic by overriding `createRequest()` and `parseResponse()`.
|
|
12
|
+
- Wrap in `ValidationAPIProvider` to add automatic validation of request payloads and response results against endpoint schemas.
|
|
13
|
+
|
|
14
|
+
The concrete network provider. `ClientAPIProvider` sends requests over the network with the global `fetch()` API and is the innermost provider in almost every chain.
|
|
15
|
+
|
|
16
|
+
The constructor takes `{ url, options?, timeout? }` — a base URL that endpoint paths are resolved against, optional default `RequestInit` options, and a request timeout in milliseconds (default `20000`).
|
|
17
|
+
|
|
18
|
+
## Usage
|
|
19
|
+
|
|
20
|
+
```ts
|
|
21
|
+
import { ClientAPIProvider } from "shelving/api"
|
|
22
|
+
|
|
23
|
+
const provider = new ClientAPIProvider({
|
|
24
|
+
url: "https://api.example.com",
|
|
25
|
+
timeout: 10_000,
|
|
26
|
+
})
|
|
27
|
+
|
|
28
|
+
const user = await provider.call(getUser, { id: "u_123" })
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
In practice you wrap it — e.g. `new ValidationAPIProvider(new ClientAPIProvider({ url }))` — so payloads and results are validated. See `shelving/api` for building a provider chain.
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
## Signatures
|
|
35
|
+
|
|
36
|
+
```ts
|
|
37
|
+
new ClientAPIProvider<P, R>({ url, options = {}, timeout = 20_000 }: ClientAPIProviderOptions)
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Parameters
|
|
41
|
+
|
|
42
|
+
| Param | Type | Description |
|
|
43
|
+
| --- | --- | --- |
|
|
44
|
+
| `options` | `ClientAPIProviderOptions` | |
|
|
45
|
+
| `.url` | `PossibleURL` | The common base URL for all rendered endpoint requests. Note: When resolving URLs for endpoints this is treated as if it ends in a slash. - e.g. in `http://p.com/a/b/c` the path will be relative to `c` as if a `/` trailing slash was present. - This is different to the default behaviour of `new URL()`, but is the more natural expected result - This is consistent with our e.g. `getURL()` utilities. Read only. |
|
|
46
|
+
| `.options` | `Omit<RequestOptions, "signal">` | Options used for HTTP requests created with `this.createRequest()` and `this.fetch()` - Omits `signal` because it's not relevant at the provider level. Read only. Optional. |
|
|
47
|
+
| `.timeout` | `number \| undefined` | Timeout in milliseconds before the request is aborted with `TimeoutError`. - Defaults to `20_000` (20 seconds) — chosen to fire before common platform wall-clock caps (Cloudflare Workers ~30s, Vercel/AWS API Gateway ~29s) so the abort propagates as a clean rejection instead of an opaque runtime termination. - Pass `0` to disable the timeout (e.g. for streaming or long-poll endpoints). Raise it for specifically slow endpoints. Read only. Optional. |
|
|
48
|
+
|
|
49
|
+
## Returns
|
|
50
|
+
|
|
51
|
+
| Type | Description |
|
|
52
|
+
| --- | --- |
|
|
53
|
+
| `ClientAPIProvider<P, R>` | |
|
|
54
|
+
|
|
55
|
+
## Properties
|
|
56
|
+
|
|
57
|
+
| Property | Type | Description |
|
|
58
|
+
| --- | --- | --- |
|
|
59
|
+
| `options` | `RequestOptions` | Default options used for HTTP requests created with `this.createRequest()` and `this.fetch()` Read only. |
|
|
60
|
+
| `timeout` | `number` | Timeout in milliseconds before the request is aborted, or `0` for no timeout. Read only. |
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ClientAPIProviderOptions
|
|
2
|
+
|
|
3
|
+
- Kind: interface
|
|
4
|
+
- Import: `import { ClientAPIProviderOptions } from "shelving/api";`
|
|
5
|
+
|
|
6
|
+
Options for constructing a `ClientAPIProvider`.
|
|
7
|
+
|
|
8
|
+
## Signatures
|
|
9
|
+
|
|
10
|
+
```ts
|
|
11
|
+
{
|
|
12
|
+
readonly url: PossibleURL;
|
|
13
|
+
readonly options?: Omit<RequestOptions, "signal">;
|
|
14
|
+
readonly timeout?: number | undefined;
|
|
15
|
+
}
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Properties
|
|
19
|
+
|
|
20
|
+
| Property | Type | Description |
|
|
21
|
+
| --- | --- | --- |
|
|
22
|
+
| `url` | `PossibleURL` | The common base URL for all rendered endpoint requests. Note: When resolving URLs for endpoints this is treated as if it ends in a slash. - e.g. in `http://p.com/a/b/c` the path will be relative to `c` as if a `/` trailing slash was present. - This is different to the default behaviour of `new URL()`, but is the more natural expected result - This is consistent with our e.g. `getURL()` utilities. Read only. |
|
|
23
|
+
| `options` | `Omit<RequestOptions, "signal">` | Options used for HTTP requests created with `this.createRequest()` and `this.fetch()` - Omits `signal` because it's not relevant at the provider level. Read only. Optional. |
|
|
24
|
+
| `timeout` | `number \| undefined` | Timeout in milliseconds before the request is aborted with `TimeoutError`. - Defaults to `20_000` (20 seconds) — chosen to fire before common platform wall-clock caps (Cloudflare Workers ~30s, Vercel/AWS API Gateway ~29s) so the abort propagates as a clean rejection instead of an opaque runtime termination. - Pass `0` to disable the timeout (e.g. for streaming or long-poll endpoints). Raise it for specifically slow endpoints. Read only. Optional. |
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# DELETE()
|
|
2
|
+
|
|
3
|
+
- Kind: function
|
|
4
|
+
- Import: `import { DELETE } from "shelving/api";`
|
|
5
|
+
|
|
6
|
+
Define a `DELETE` endpoint at a path, with validated payload and result types.
|
|
7
|
+
- "The DELETE method deletes the specified resource."
|
|
8
|
+
|
|
9
|
+
*Factory for `Endpoint`.*
|
|
10
|
+
|
|
11
|
+
## Signatures
|
|
12
|
+
|
|
13
|
+
```ts
|
|
14
|
+
DELETE(path: AbsolutePath, payload?: Schema<P>, result?: Schema<R>): Endpoint<P, R>
|
|
15
|
+
DELETE(path: AbsolutePath, payload: Schema<P>): Endpoint<P, undefined>
|
|
16
|
+
DELETE(path: AbsolutePath, payload: undefined, result: Schema<R>): Endpoint<undefined, R>
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Parameters
|
|
20
|
+
|
|
21
|
+
| Param | Type | Description |
|
|
22
|
+
| --- | --- | --- |
|
|
23
|
+
| `path` | `AbsolutePath` | The endpoint path, possibly including `{placeholders}` |
|
|
24
|
+
| `payload` | `Schema<P>` | An optional `Schema` validating the request payload. Optional. |
|
|
25
|
+
| `result` | `Schema<R>` | An optional `Schema` validating the response result. Optional. |
|
|
26
|
+
| `path` | `AbsolutePath` | |
|
|
27
|
+
| `payload` | `Schema<P>` | |
|
|
28
|
+
| `payload` | `undefined` | |
|
|
29
|
+
| `result` | `Schema<R>` | |
|
|
30
|
+
|
|
31
|
+
## Returns
|
|
32
|
+
|
|
33
|
+
| Type | Description |
|
|
34
|
+
| --- | --- |
|
|
35
|
+
| `Endpoint<P, R>` | An `Endpoint` configured for the `DELETE` method. |
|
|
36
|
+
| `Endpoint<P, undefined>` | |
|
|
37
|
+
| `Endpoint<undefined, R>` | |
|
|
38
|
+
|
|
39
|
+
## Examples
|
|
40
|
+
|
|
41
|
+
```ts
|
|
42
|
+
DELETE("/users/{id}")
|
|
43
|
+
```
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# DebugAPIProvider
|
|
2
|
+
|
|
3
|
+
- Kind: class
|
|
4
|
+
- Import: `import { DebugAPIProvider } from "shelving/api";`
|
|
5
|
+
- Extends: `ThroughAPIProvider<P, R>`
|
|
6
|
+
|
|
7
|
+
Provider that logs every request, response, and error to the console in detail to help diagnose issues in development.
|
|
8
|
+
|
|
9
|
+
A wrapping provider for development. `DebugAPIProvider` writes verbose console output for every call — including full request and response bodies — so you can see exactly what is going over the wire.
|
|
10
|
+
|
|
11
|
+
It is the noisy counterpart to `LoggingAPIProvider`: use `DebugAPIProvider` while developing, and `LoggingAPIProvider` (or nothing) in production.
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
```ts
|
|
16
|
+
import { ClientAPIProvider, DebugAPIProvider } from "shelving/api"
|
|
17
|
+
|
|
18
|
+
const provider = new DebugAPIProvider(
|
|
19
|
+
new ClientAPIProvider({ url: "https://api.example.com" })
|
|
20
|
+
)
|
|
21
|
+
|
|
22
|
+
await provider.call(getUser, { id: "u_123" })
|
|
23
|
+
// Console shows the full request and response, including bodies.
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
## Signatures
|
|
28
|
+
|
|
29
|
+
```ts
|
|
30
|
+
new DebugAPIProvider<P, R>()
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Returns
|
|
34
|
+
|
|
35
|
+
| Type | Description |
|
|
36
|
+
| --- | --- |
|
|
37
|
+
| `DebugAPIProvider<P, R>` | |
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Endpoint.match()
|
|
2
|
+
|
|
3
|
+
- Kind: method
|
|
4
|
+
- Member of: `Endpoint`
|
|
5
|
+
|
|
6
|
+
Match a method/path pair against this endpoint and return any matched `{placeholder}` params.
|
|
7
|
+
|
|
8
|
+
## Signatures
|
|
9
|
+
|
|
10
|
+
```ts
|
|
11
|
+
match(method: RequestMethod, path: AbsolutePath, caller: AnyCaller = this.match): RequestParams | undefined
|
|
12
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Endpoint.renderPath()
|
|
2
|
+
|
|
3
|
+
- Kind: method
|
|
4
|
+
- Member of: `Endpoint`
|
|
5
|
+
|
|
6
|
+
Render the path for this endpoint with the given payload.
|
|
7
|
+
- Path might contain `{placeholder}` values that are replaced with values from `payload`.
|
|
8
|
+
|
|
9
|
+
## Signatures
|
|
10
|
+
|
|
11
|
+
```ts
|
|
12
|
+
renderPath(payload: P, caller: AnyCaller = this.renderPath): AbsolutePath
|
|
13
|
+
```
|