Skip to content

Latest commit

 

History

History
228 lines (173 loc) · 8.38 KB

README.md

File metadata and controls

228 lines (173 loc) · 8.38 KB
Raw

@angular-kit/rx-stateful

rxStateful$ is a powerful RxJs operator that wraps async Observable and provides a stateful stream. It does offer out of the box

  • 🔄 loading state
  • ❌ automatic error handling
  • 🔄 refresh-mechanisms
  • 🔴 multicasted stream
  • ⚙️ powerful configuration possibilities e.g. to keep the last value on refresh
  • ⚡️ non-flickering loading state for great UX

Installation

npm install @angular-kit/rx-stateful
yarn add @angular-kit/rx-stateful
pnpm add @angular-kit/rx-stateful

Demo

A live demo is available on here

Usage

rxRequest standalone function

Tip

rxRequest is basically the same as rxStateful$ but with a more ergonomic API. It is recommended to use rxRequest instead of rxStateful$.

Basic Usage

import { rxRequest } from '@angular-kit/rx-stateful';


const req = rxRequest({
    // optional trigger. If given the requestFn will only be executed if the trigger emits. If not given the requestFn will be executed immediately on subscribe
    trigger: trigger$,
    // the request function. This can be a function that returns an Observable e.g. vrom an http call
    requestFn: () => from(fetch('...')),
    config: {...}
})

// get the state stream
/**
 * Async Observable will return: 
 * [
 * { value: null, hasValue: false, context: 'suspense', hasError: false, error: undefined },
 * { value: SOME_VALUE, hasValue: true, context: 'next', hasError: false, error: undefined },
 * ]
 */
const value$ = req.value$();

API

rxRequest.value$() returns a Observable of with following properties:

  • value - the value
  • hasValue - boolean if a value is present
  • context - the context of the stream ('suspense', 'next', 'error', 'complete')
  • hasError - boolean if an error is present
  • error - the error, if present
  • isSuspense - suspense/loading state

rxRequest.refresh() offers a convenient way to trigger a refresh of the source. It will trigger the source again and emit the new states.

rxStateful$ standalone function

Basic Usage

import { rxStateful$ } from '@angular-kit/rx-stateful';

/**
 * Async Observable will return: 
 * [
 * { value: null, hasValue: false, context: 'suspense', hasError: false, error: undefined },
 * { value: SOME_VALUE, hasValue: true, context: 'next', hasError: false, error: undefined },
 * ]
 */

const stateful$ = rxStateful$(from(fetch('...')));

const trigger$$ = new Subject<number>()
const refresh$$ = new Subject<void>()
const stateful$ = rxStateful$((id: number) => from(fetch(`.../${id}`)), {
    sourceTriggerConfig: {
        trigger: trigger$$
    },
    refetchStrategy: withRefetchOnTrigger(refresh$$)
});

API

rxStateful$ returns a Observable of with following properties:

  • value - the value
  • hasValue - boolean if a value is present
  • context - the context of the stream ('suspense', 'next', 'error', 'complete')
  • hasError - boolean if an error is present
  • error - the error, if present
  • isSuspense - suspense/loading state

Configuration of rxStateful$ or rxRequest

Both rxRequest and rxStateful$ provides configuration possibility on instance level or globally.

Global configuration

You can provide a global configuration for rxStateful$ and rxRequest. This configuration will be used for every instance of rxStateful$ and rxRequest.

Use provideRxStatefulConfig in either your AppModule or appConfig to provide a global configuration.

Configuration on instance level

You can also provide a configuration on instance level. This will also override the global configuration (if present).

  • keepValueOnRefresh - boolean if the value should be kept when the refreshTrigger$ emits. Default: false
  • keepErrorOnRefresh - boolean if thel last error should be kept when the refreshTrigger$ emits. Default: false
  • refreshTrigger$ - a Subject or Observable that triggers the source again. Default: not set. deprecated use refetchStrategies
  • refetchStrategies - single or multiple RefetchStrategies to trigger the source again. Default: not set
  • suspenseThresholdMs - number of milliseconds to wait before emitting the suspense state. Default: 0
  • suspenseTimeMs - number of milliseconds to wait before the next state after the suspense state. Default: 0

Tip

A few more words about the suspenseThresholdMs and suspenseTimeMs configuration. This is a quite powerful feature which will result in a better UX when preventing flickering loading states. What does flickering loading states mean? When you show a loading indicator/spinner based on the isSuspense-property then a common scenario is that you show a spinner for a very short tim for fast requests resulting in some flickering. To prevent this it is better to wait a certain amount of time before showing a spinner (suspenseThreshold). If then the request takes longer thant the threshold-time a spinner will be shown for at least another amount of time (suspenseTime). That way you can prevent flickering spinners.

rxStateful$ provides exactly this feature and will only emit the suspense-state if a async-operation takes longer than the specified suspenseThresholdMs for at least suspenseTimeMs. A reasonable configuration of these two values would be to set them both to 500ms.

Important

The default value for suspenseThresholdMs and suspenseTimeMs is 0, therefor by default you will not use the non-flickering loading state feature. It is choosen that way to break existing behavior. This might change in a future major version.

Configuration Example
import { rxStateful$, rxRequest } from '@angular-kit/rx-stateful';

const rxStateful$ = rxStateful$(someSource$, { keepValueOnRefresh: true });
const rxRequest = rxRequest({ requestFn: () => someSource$, config: { keepValueOnRefresh: true } });
refetchStrategies
  • withRefetchOnTrigger
  • withAutoRefetch

Usage via RxStatefulClient

Caution

The RxStatefulClient is a experimental feature. Breaking changes might occur in any version update.

In order to use RxStatefulClient you first need to provide it, e.g. in your AppModule:

import {provideRxStatefulClient} from "@angular-kit/rx-stateful";

@NgModule({
    providers: [
        provideRxStatefulClient()
    ],
})
export class AppModule {}

RxStatefulClient offers a request-method which basically has the same signature as rxStateful$ - so there'is no difference in usage.

Global configuration

provideRxStatefulClient() can be configured:

import {provideRxStatefulClient, withConfig} from "@angular-kit/rx-stateful";

@NgModule({
    providers: [
        provideRxStatefulClient(withConfig({ keepValueOnRefresh: true}))
    ],
})
export class AppModule {}

The global configuration will be used for every request-call. You can still override the global configuration by providing a configuration object as second parameter to request-method.

Configuring refresh behaviour

Both rxStateful$ and RxStatefulClient can be configured to refresh the source (e.g. make a HTTP call again).

To define the refresh behaviour you can make use of so called RefetchStrategy's. Right now there are following strategies built in: withAutoRefetch and withRefetchOnTrigger.

Usage on rxStateful$

```typescript
    const instance = rxStateful$(fetch(), { refetchStrategy: [withAutoRefetch(1000, Infinity)] })

Usage on RxStatefulClient

const client = inject(RxStatefulClient);
const instance = client.request(fetch(), { refetchStrategy: [withAutoRefetch(1000, Infinity)] })

All strategies can be cominded in an arbitrary way.

In the future there will come more strategies built in, as well as an easy way to define custom strategies. However defining custom strategies is already possible by implementing the RefetchStrategy interface.

Testing

Please have a look at the testing documentation.

Versioning

This project follows Semantic Versioning.

Angular Compatibility

  • Version 2.x.x requires Angular >=18.0.0
  • Version 1.x.x requires Angular >=14.0.0

License

MIT

Contributing

Any Contributions are welcome. Please open up an issue or create PR if you would like to contribute.

See CONTRIBUTING.md for more information.