jsonplaceholder_offline 1.0.3

jsonplaceholder_offline #

A simple package that allows you to get data for your project on the go without relying on the network

Installation #

Add this to your package's pubspec.yaml file

dependencies:
    jsonplaceholder_offline: 1.0.3

and run

flutter packages get

How it work #

The package is offline version ofJsonPlaceholder Jsonplaceholder has 6 different data categories:

  • User
  • Post
  • Comment
  • Album
  • Photo
  • Todo

you can get data in two format either object or json.

  • to get object data you will need to call getData<T>(length:1) method with length as a parameter
  • to get json data you will need to call getJsonData<T>(length:1) method with length as a parameter

NB:

  • length is number of data you wish to return. from (min 1 - max 100)

  • T is the generic reference of your category.

    Usage #

    Getting Object data #

list of Users #

JsonPlaceholder jsonPlaceholder = JsonPlaceholder();
List<User> users = jsonPlaceholder.getData<User>(length: 20);

a single User object #

JsonPlaceholder jsonPlaceholder = JsonPlaceholder();
User user = jsonPlaceholder.getData<User>(length:1);

Getting Json data #

list of users data #

JsonPlaceholder jsonPlaceholder = JsonPlaceholder();
List<Map<String, dynamic>> users = jsonPlaceholder.getJsonData<User>(length: 20);

a single User json #

JsonPlaceholder jsonPlaceholder = JsonPlaceholder();
Map<String, dynamic> user = jsonPlaceholder.getJsonData<User>(length:1);

Get UserPost by userId #

 JsonPlaceholder jsonPlaceholder = JsonPlaceholder();
 List<dynamic> comments = jsonPlaceholder.getUserPosts(userId: 1, toJson: false);

*NB: toJson property can be set to true if you want the return data to be in JSON format*

Get PostComment by postId #

JsonPlaceholder jsonPlaceholder = JsonPlaceholder();
List<dynamic> comments = jsonPlaceholder.getUserPosts(postId: 1, toJson: false);

*NB: toJson property can be set to true if you want the return data to be in JSON format*

Mocking HTTP Request #

if you want to get your data in HTTP Request behaviour, you can mock the behaviour using mockHttp<T>({RESTMETHOD httpMethod, int delay, int length})

JsonPlaceholder jsonPlaceholder = JsonPlaceholder();
Map<String, dynamic> data = await jsonPlaceholder.mockHttp<User>(httpMethod: RESTMETHOD.GET, length: 10, delay: 20);

NB:

  • httpMethod: {GET,POST,PUT,DELETE}
  • delay: This is the number of seconds you want your request to take before it return data.
  • length: This is the number of data you want to return

Data credit: https://jsonplaceholder.typicode.com/

[0.0.1]

  • Initial version of the library

[1.0.0]

  • Update the documentation
  • Add object to json feature

[1.0.1]

  • Update the documentation
  • Add get PostComments feature
  • Add get UserPosts feature

[1.0.2]

  • Bug fix
  • Improved documentation

[1.0.3]

  • Add mockHttp feature
  • updated the documentation

example/README.md

example #

A new Flutter project.

Getting Started #

This project is a starting point for a Flutter application.

A few resources to get you started if this is your first Flutter project:

For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

Use this package as a library

1. Depend on it

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


dependencies:
  jsonplaceholder_offline: ^1.0.3

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:jsonplaceholder_offline/jsonplaceholder_offline.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
13
Health:
Code health derived from static analysis. [more]
99
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
56
Learn more about scoring.

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

  • Dart: 2.7.1
  • pana: 0.13.5
  • Flutter: 1.12.13+hotfix.7

Health issues and suggestions

Document public APIs. (-0.67 points)

89 out of 90 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your 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
test any