# @datx/network > DatX network layer Latest version **3.0.0** (published 2023-06-29) · MIT license · 0 weekly downloads ## Install ```sh npm install @datx/network pnpm add @datx/network yarn add @datx/network bun add @datx/network ``` ## Health **Score 35/100 (D)** — status: abandoned. Positive: has types; esm support; no vulnerabilities. Warnings: low downloads. Negative: abandoned. ## Facts | | | |---|---| | Version | 3.0.0 | | Published | 2023-06-29 | | First published | 2021-01-23 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 2 | | Unpacked size | 224.7 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 146 | | Author | Infinum JavaScript Team | | Maintainers | danipavic, kristian240, infinumcom, darkokukovec, safo6m, fvoska, ivicabatinic | | Keywords | datx | ## Links - npm: https://www.npmjs.com/package/@datx/network - Repository: https://github.com/infinum/datx - Homepage: https://github.com/infinum/datx#readme - Issues: https://github.com/infinum/datx/issues - npm.io page: https://npm.io/package/@datx/network ## Dependencies (2) - [@datx/core](https://npm.io/package/@datx/core.md) 3.0.0 - [@datx/utils](https://npm.io/package/@datx/utils.md) 3.0.0 ## Recent versions - 3.0.0 (latest) — 2023-06-29 - 2.6.2-beta.2 (beta) — 2023-08-07 - 3.0.0-alpha.0 (alpha) — 2022-03-29 - 2.6.2-beta.1 — 2023-07-20 - 2.6.2-beta.0 — 2023-07-11 - 3.0.0-beta.1 — 2023-06-29 - 2.6.1 — 2023-06-12 - 2.5.1 — 2023-04-20 - 2.5.0-beta.11 — 2023-03-23 - 2.4.12 — 2023-01-25 - 2.4.11 — 2023-01-19 - 2.5.0-beta.6 — 2022-12-14 - 2.4.8 — 2022-11-14 - 2.4.6 — 2022-09-23 - 2.4.5 — 2022-09-07 - … 12 more at https://npm.io/package/@datx/network/versions ## README # @datx/network DatX is an opinionated data store. It features support for references to other models and first-class TypeScript support. `@datx/network` is a datx mixin that adds a networking layer support. It can be used with any REST-like API and probably also other types of an API. --- ## Basic usage ```tsx import { Collection, Model, Attribute } from '@datx/core'; import { BaseRequest, collection, setUrl } from '@datx/network'; class Person extends Model { public static type = 'person'; // Unique name of the model class @Attribute() public name: string; // A normal attribute without a default value @Attribute() public surname: string; @Attribute({ toOne: Person }) public spouse?: Person; // A reference to a Person model public get fullName() { return `${this.name} ${this.surname}`; } } class AppData extends Collection { public static types = [Person]; // A list of models available in the collection } const store = new AppData(); // Create a base request with a basic configuration (baseUrl and linked collection) const baseRequest = new BaseRequest('https://example.com').pipe(collection(store)); // Create separate request points const getPerson = baseRequest.pipe(setUrl('/people/{id}', Person)); const getPeople = baseRequest.pipe>(setUrl('/people', Person)); // Pure JS loading const peopleResponse = await getPeople.fetch(); // Loading in a React component const PersonInfo = ({ userId }) => { const [response, loading, error] = getPerson.useHook({ id: userId }); if (loading || error) { return null; } const user = response.data; return
{user.fullName}
; }; ``` ## Getting started ```bash npm install --save @datx/network ``` ### Polyfilling The lib makes use of the following features that are not yet available everywhere. Based on your browser support, you might want to polyfill them: - [Symbol.for](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol) - [Object.assign](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/assign) - [Array.prototype.find](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/find) - [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) - [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) [How to add the polyfills](https://datx.dev/docs/troubleshooting/known-issues#the-library-doesnt-work-in-internet-explorer-11). Note: Fetch API is not included in the polyfills mentioned in the Troubleshooting page. Instead, you need to add it as a separate library. If you don't have any special requirements (like server-side rendering), you can use the [window.fetch polyfill](https://github.com/github/fetch#installation). ## API reference - [BaseRequest](https://datx.dev/docs/network/base-request) - [Response](https://datx.dev/docs/network/response) - [operators](https://datx.dev/docs/network/operators) - [caching](https://datx.dev/docs/network/caching) - [interceptors](https://datx.dev/docs/network/interceptors) - [parse/serialize](https://datx.dev/docs/network/parse-serialize) - [fetching](https://datx.dev/docs/network/fetching) - [TypeScript Interfaces](https://datx.dev/docs/network/typescript-interfaces) ## Troubleshooting Having issues with the library? Check out the [troubleshooting](https://datx.dev/docs/troubleshooting/known-issues) page or [open](https://github.com/infinum/datx/issues/new/choose) an issue. --- [![Build Status](https://travis-ci.org/infinum/datx.svg?branch=master)](https://travis-ci.org/infinum/datx) [![npm version](https://badge.fury.io/js/@datx/network.svg)](https://badge.fury.io/js/@datx/network) [![Dependency Status](https://david-dm.org/infinum/datx.svg?path=packages/@datx/network)](https://david-dm.org/infinum/datx?path=packages/@datx/network) [![devDependency Status](https://david-dm.org/infinum/datx/dev-status.svg?path=packages/@datx/network)](https://david-dm.org/infinum/datx?path=packages/@datx/network#info=devDependencies) ## License The [MIT License](LICENSE) ## Credits @datx/network is maintained and sponsored by [Infinum](https://www.infinum.com).

--- _Source: https://npm.io/package/@datx/network · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._