hacker_news_client 0.1.0

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • new66

hacker_news_client

Build Status codecov

A Dart client for the Hacker News API. Works on Flutter, Server, and Web.

Usage

No need for an API key or anything, just create an instance of the client and fetch results!

// Create a client and pass in an http.Client.
//   - For Flutter & Server, use IOClient
//   - For Web, use BrowserClient
final client = HackerNewsClient(IOClient());

// Fetch the top stories. Does not include all comments.
final topStories = await client.topStories();

// Fetch the newest stories. Does not include all comments
final newStories = await client.newStories();

// Fetch a story with all comments
final newStories = await client.story(8863);

Features and bugs

Please file feature requests and bugs at the issue tracker.

0.1.0

  • Initial version of a a Hacker News Client for Dart
  • Works on Flutter, Server, and Web
  • Covered by tests
  • Supports:
    • Top Stories
    • Best Stories
    • New Stories
    • Jobs
    • Ask Hacker News
    • Show Hacker News
    • Story with all comments
    • Poll with Options and all comments
    • User

Use this package as a library

1. Depend on it

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


dependencies:
  hacker_news_client: ^0.1.0

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter packages get

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

3. Import it

Now in your Dart code, you can use:


import 'package:hacker_news_client/hacker_news_client.dart';
  
Version Uploaded Documentation Archive
0.1.0 Jul 21, 2018 Go to the documentation of hacker_news_client 0.1.0 Download hacker_news_client 0.1.0 archive
Popularity:
Describes how popular the package is relative to other packages. [more]
31
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
66
Learn more about scoring.

We analyzed this package on Aug 10, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.0.0
  • pana: 0.11.8

Platforms

Detected platforms: Flutter, web, other

No platform restriction found in primary library package:hacker_news_client/hacker_news_client.dart.

Suggestions

Package is pre-v1 release.

While there is nothing inherently wrong with versions of 0.*.*, it usually means that the author is still experimenting with the general direction of the API.

Maintain an example.

Create a short demo in the example/ directory to show how to use this package. Common file name patterns include: main.dart, example.dart or you could also use hacker_news_client.dart.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.50.0 <3.0.0
built_collection ^3.1.1 3.1.3
built_value ^5.5.3 5.5.5 6.0.0
http ^0.11.3+17 0.11.3+17
Transitive dependencies
async 2.0.8
charcode 1.1.2
collection 1.14.11
fixnum 0.10.8
http_parser 3.1.3
matcher 0.12.4
meta 1.1.6
path 1.6.2
quiver 2.0.0+1
source_span 1.4.1
stack_trace 1.9.3
string_scanner 1.0.3
typed_data 1.1.6
Dev dependencies
build_runner ^0.9.0
built_value_generator ^5.5.3
coverage 0.12.1
test ^1.0.0