remote_data 0.0.2

  • Readme
  • Changelog
  • Installing
  • new49

remote_data #

A Flutter package use to handle remote data, inspired by remote-data-ts.

How to use #

When we fetching remote data, we will have four states.

  • NotAsked
  • Loading
  • Success
  • Failure

To render each states, we have RemoteDataBuilder and StreamRemoteDataBuilder. However, I recommand using StreamRemoteDataBuilder, to avoid setState frequency.

StreamRemoteDataBuilder #

import 'package:remote_data/remote_data.dart';

class Home extends StatelessWidget {
  @override
  _HomeState createState() => _HomeState();
}

class _HomeState extends State<Home> {
  Stream<RemoteData> _remoteData;

  void _search(String keyword) {
    setState(() => _remoteData = _doSearch(keyword));
  }

  Stream<RemoteData> _doSearch(String keyword) async* {
    yield Loading();
    try {
      final String value = await _fetchSomeData();
      yield Success(value);
    } catch (error) {
      yield Failure(error);
    }
  }

  @override
  Widget build(BuildContext context) {
    return Column(
      children: [
        TextField(
          onChanged: _search,
        ),
        StreamRemoteDataBuilder<String>(
          stream: _remoteData,
          notAskedBuilder: (context) => Text("not asked"),
          loadingBuilder: (context) => Text("loading"),
          successBuilder: (context, value) => Text(value),
          failureBuilder: (context, error) => Text(error.toString()),
        ),
      ],
    );
  }
}

[0.0.1] - TODO: Add release date. #

  • TODO: Describe initial release.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  remote_data: ^0.0.2

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:remote_data/remote_data.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
5
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
80
Overall:
Weighted score of the above. [more]
49
Learn more about scoring.

We analyzed this package on Mar 26, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.7.1
  • pana: 0.13.6
  • Flutter: 1.12.13+hotfix.8

Health suggestions

Format lib/remote_data.dart.

Run flutter format to format lib/remote_data.dart.

Maintenance suggestions

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and remote_data.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

Package is pre-v0.1 release. (-10 points)

While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.11 1.14.12
meta 1.1.8
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test