routes 0.1.4

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • 34

##ROUTES 0.1.3

Is a simple server routing via a single routes.dart file

routes builds on route and params package route and params

  1. add dependencies to pubspec

    route: "^0.4.6"
    
    routes: "^0.1.4"
    
  2. create a routes file ###ROUTES

inside projectRootFolder/routes.dart

   part of sampleServerGui;
  
   final Map serverRoutes={
     'byeJs':{'url':new UrlPattern(r'/byeJs'),'action': byeJs,'async':true },
     'helloDart':{'url':new UrlPattern(r'/helloDart'),'method':'GET','action': helloDart }
   };

here we see 2 routes 'byeJs' and 'helloDart'

routes always have a

url -> url pattern and an

action -> called method and an optional

method -> that currently handels 'PUT' and 'GET'

  1. create the simple server with functions for each specified action (helloDart,byeJs) ###SERVER

projectRootFolder/bin/simpleServer.dart

   library sampleServerGui;
   
   import "dart:io";
   import 'dart:convert';
   import 'package:route/url_pattern.dart';
   import 'package:routes/server.dart';
  
   part '../routes.dart';
   
   final String HOST = "127.0.0.1"; // eg: localhost
   
   final num PORT = 8079;
   
   main() async {
       var server = await HttpServer.bind(HOST, PORT);
       var router = initRouter(server, serverRoutes);
       print("Listening for GET and POST on http://$HOST:$PORT");
   }
  
   void printError(error) => print(error);
  
   helloDart(Map params, HttpResponse res){
     Map newMap = {"language":params["language"]};
     if(params["language"] == "Dart"){
       newMap["text"]="Hello";
     }else{
       newMap["text"]="GOODBYE";
     }
     res.write(JSON.encode(newMap));
     res.close();
   }

   byeJs(Map params, HttpResponse res){
     //do stuff
   }

now you can talk to the server eg with http://127.0.0.1:8079/helloDart?language=Dart


###WHATS HAPPENING

the Magic happens here

  var router = initRouter(server, serverRoutes);
  

it automatically generates a router that will use the specified routes in routes.dart

the action specified inside the routes will recieve 2 parameters

a Map params -> including the parameters send in the request a HTTPResponse res


Download a working example here

VERSION

0.1.3 -added changelog.md
0.1.2 -remove filter again for now
0.1.1 -fix readme
      -added filter for router
0.1.0 -removed rootPath parameter from InitRouter() function
      -added readme.md and license.md
0.0.1 -initial commit supports server routing

1. Depend on it

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


dependencies:
  routes: "^0.1.4"

2. Install it

You can install packages from the command line:

with pub:


$ pub get

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

3. Import it

Now in your Dart code, you can use:


import 'package:routes/client.dart';

import 'package:routes/server.dart';
        
Version Uploaded Documentation Archive
0.1.4 May 11, 2016 Go to the documentation of routes 0.1.4 Download routes 0.1.4 archive
0.1.3 Aug 13, 2014 Go to the documentation of routes 0.1.3 Download routes 0.1.3 archive
0.1.2 Aug 13, 2014 Go to the documentation of routes 0.1.2 Download routes 0.1.2 archive
0.1.1 Aug 13, 2014 Go to the documentation of routes 0.1.1 Download routes 0.1.1 archive
0.1.0 Aug 13, 2014 Go to the documentation of routes 0.1.0 Download routes 0.1.0 archive
0.0.1 Aug 12, 2014 Go to the documentation of routes 0.0.1 Download routes 0.0.1 archive

Analysis

This feature is new.
We welcome feedback.
More details: scoring.

We analyzed this package, and provided a score, details, and suggestions below.

  • completed on Feb 3, 2018
  • Dart: 2.0.0-dev.20.0
  • pana: 0.10.1

Scores

Popularity:
Describes how popular the package is relative to other packages. [more]
0 / 100
Health:
Code health derived from static analysis. [more]
95 / 100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
26 / 100
Overall score:
Weighted score of the above. [more]
34

Platforms

Detected platforms: web

Platform components identified in package: html, io, mirrors.

Suggestions

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

  • 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 routes.dart.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.4.0 <2.0.0
params >=0.0.3 <0.1.0 0.0.4
route >=0.4.6 <0.5.0 0.4.6
route_hierarchical >=0.4.22 <1.0.0 0.7.0
Transitive dependencies
browser 0.10.0+2
logging 0.11.3+1