@typedly/data
v6.1.0
Published
A TypeScript type definitions package for @typescript-package/data.
Maintainers
Readme
@typedly/data
A TypeScript type definitions package for @typescript-package/data.
Features
- Adapter: Optional data adapter to customize managing underlying data available under the
@typedly/adaptable-data. - Configurable: Configurable data shape available under the
@typedly/configurable-data. - Traits: Extended customization via traits, such as
Configurable,Adaptable,Serializable, andTransformableunder the@typedly/data-traitspackage. - Shape: The default shape for data of any
Ttype with conditional async.
Table of contents
Related packages
- @typedly/adaptable-data: A TypeScript type definitions for data adapter.
- @typedly/collection: A TypeScript type definitions package for data collections with customizable storage.
- @typedly/configurable-data: A TypeScript type definitions for configurable data.
- @typedly/data-adapter: A TypeScript type definitions for data adapter.
- @typedly/data-traits: A TypeScript type definitions for data traits.
- @typescript-package/data: A lightweight TypeScript library for basic data management.
- @typescript-package/collection: A lightweight TypeScript library for data collection.
Installation
Peer dependencies
npm install @typedly/constructor --save-peerThe package
npm install @typedly/data --save-peerApi
import {
// Configuration
CacheableDataSettings,
CacheableSettings,
DataConfig,
DataSettings,
// Inference.
InferAsync,
InferAsyncOf,
InferValue,
// Iterable.
IterValue,
IterableElement,
// Data.
DataConstructor,
DataShape,
// Return types
AsyncReturn,
// Input types
DataConstructorInput,
DataConstructorTuple,
// Value.
ValueConstructor,
ValueShape,
} from '@typedly/data';Configuration
CacheableDataSettings
The cacheable data settings type combines the data settings with the cacheable settings, allowing for optional or required asynchronous functions for fetching and updating the data value based on the read-only flag.
import { CacheableDataSettings } from '@typedly/data';CacheableSettings
The cacheable settings interface defines the structure for configuring cacheable data operations, including optional asynchronous functions for clearing, destroying, fetching, and updating the data value.
import { CacheableSettings } from '@typedly/data';DataConfig
The type for the data configuration, which can be either a full configuration object of C or just an async flag.
import { DataConfig } from '@typedly/data';DataSettings
The settings for a data type.
import { DataSettings } from '@typedly/data';Inference
InferAsyncOf
Infers the async flag from a tuple of arguments, returning true if any of the arguments has an async flag set to true.
import { InferAsync } from '@typedly/data';InferAsync
Infers the async flag from the settings DataSettings or shape DataShape.
import { InferAsync } from '@typedly/data';InferValue
Infers the value type from a data shape interface.
import { InferAsync } from '@typedly/data';Iterable
IterElement
The iterate element type.
import { IterElement } from '@typedly/data';IterValue
The iterated value type.
import { IterValue } from '@typedly/data';Data
AsyncReturn
The conditional return type for async methods.
import { AsyncReturn } from '@typedly/data';DataConstructorInput
The input type for data constructors, with arguments support.
import { DataConstructorInput } from '@typedly/data';DataConstructorTuple
The input type for data constructors, with arguments support.
import { DataConstructorTuple } from '@typedly/data';DataConstructor
The constructor interface for data types.
import { DataConstructor } from '@typedly/data';DataShape
The shape of a Data type.
import { DataShape } from '@typedly/data';Value
ValueConstructor
import { ValueConstructor } from '@typedly/data';ValueShape
The shape of a Value type.
import { ValueShape } from '@typedly/data';Contributing
Your contributions are valued! If you'd like to contribute, please feel free to submit a pull request. Help is always appreciated.
Support
If you find this package useful and would like to support its and general development, you can contribute through one of the following payment methods. Your support helps maintain the packages and continue adding new.
Support via:
or via Trust Wallet
Thanks for your support!
Code of Conduct
By participating in this project, you agree to follow Code of Conduct.
GIT
Commit
Versioning
Given a version number MAJOR.MINOR.PATCH, increment the:
- MAJOR version when you make incompatible API changes,
- MINOR version when you add functionality in a backwards-compatible manner, and
- PATCH version when you make backwards-compatible bug fixes.
Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.
FAQ How should I deal with revisions in the 0.y.z initial development phase?
The simplest thing to do is start your initial development release at 0.1.0 and then increment the minor version for each subsequent release.
How do I know when to release 1.0.0?
If your software is being used in production, it should probably already be 1.0.0. If you have a stable API on which users have come to depend, you should be 1.0.0. If you’re worrying a lot about backwards compatibility, you should probably already be 1.0.0.
License
MIT © typedly (license)
Packages
- @typescript-package/chain-descriptor: A TypeScript library for chain property descriptor.
- @typescript-package/controlled-descriptor: A TypeScript library for controlled property descriptor.
- @typescript-package/controller: A TypeScript package with for various kind of controllers.
- @typescript-package/descriptor-chain: A TypeScript library for property descriptor chain.
- @typescript-package/descriptor: A TypeScript library for property descriptor.
- @typescript-package/descriptors: A TypeScript library for property descriptors.
- @typescript-package/property: A TypeScript package with features to handle object properties.
- @typescript-package/wrap-descriptor: A TypeScript package for wrapping object descriptors.
- @typescript-package/wrap-property: A TypeScript package for wrapping object properties.
- @typescript-package/wrapped-descriptor: A lightweight TypeScript library for wrapped property descriptor.
- @xtypescript/property - A comprehensive, reactive TypeScript library for precise and extensible object property control.
