bson_codec 0.2.0

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • 48

bson_codec

Build Status

This package offers Dart programs a flexible serializer and deserializer for BSON documents.

Highlights

  • Standard Codec/Converter interface, as established by the standard 'dart:convert' package.
  • Best effort type mapping when serializing/deserializing values.

Examples

import 'package:bson_codec/bson_codec.dart';

main() {
  final doc = {
    '_id': 5,
    'a': [2, 3, 5]
  };
  List<int> bytes = BSON.encode(doc);
  final root = BSON.decode(bytes);
  print(doc['a'][2]); // 5
}

TODO

JavaScript code w/ scope and decimal128 are not supported yet.

Changelog

0.2.0

  • BsonEncoder/BsonDecoder supports chunked conversions

0.1.0

  • Initial version

1. Depend on it

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


dependencies:
  bson_codec: "^0.2.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 packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:bson_codec/bson_codec.dart';
        
Version Uploaded Documentation Archive
0.2.0 Oct 12, 2016 Go to the documentation of bson_codec 0.2.0 Download bson_codec 0.2.0 archive
0.1.0 Oct 8, 2016 Go to the documentation of bson_codec 0.1.0 Download bson_codec 0.1.0 archive

Analysis

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

  • Dart: 2.0.0-dev.46.0
  • pana: 0.10.6

Scores

Popularity:
Describes how popular the package is relative to other packages. [more]
18 / 100
Health:
Code health derived from static analysis. [more]
97 / 100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
51 / 100
Overall score:
Weighted score of the above. [more]
48
Learn more about scoring.

Platforms

Detected platforms: Flutter, web, other

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

Suggestions

  • Fix analysis and formatting issues.

    Analysis or formatting checks reported 26 hints.

    Strong-mode analysis of lib/bson_codec.dart gave the following hint:

    line: 18 col: 9
    'BsonUndefined' is deprecated and shouldn't be used.

    Run dartfmt to format lib/src/bson_reader.dart.

    Similar analysis of the following files failed:

    • lib/src/bson_writer.dart (hint)
    • lib/src/codec.dart (hint)
    • lib/src/types.dart (hint)
  • The description is too short.

    Add more detail about the package, what it does and what is its target use case. Try to write at least 60 characters.

  • 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 API.

  • Use analysis_options.yaml.

    Rename old .analysis_options file to analysis_options.yaml.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.8.0 <2.0.0
bson_objectid ^0.1.0 0.1.0
collection ^1.9.1 1.14.9
Dev dependencies
test >=0.12.0 <0.13.0