Default Unit (#15)

* updates api to have default millisecond unit, CI builds docs and examples

* adds ToUnit alias

.github/workflows/tests.yml → .github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: Integration Tests
+name: Run Tests, Verify Docs and Examples
 
 on:
   push:
@@ -9,7 +9,7 @@ on:
       - main
 
 jobs:
-  run-tests:
+  verify:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
@@ -25,4 +25,6 @@ jobs:
           restore-keys: ${{ runner.os }}-elm-
 
       - run: npm ci
-      - run: npm run test
+      - run: npm run test
+      - run: npm run docs:verify
+      - run: npm run examples:build

.gitignore

@@ -11,6 +11,7 @@ node_modules
 # build
 dist
 tests/program/index.js
+docs.json
 
 # editor
 .idea

README.md

@@ -19,7 +19,7 @@ To trigger a single update after a period of time pass `Delay.after` as a comman
 ```elm
 FirstMessage ->
     ( model
-    , Delay.after 500 Millisecond SecondMessage
+    , Delay.after 500 SecondMessage
     )
 ```
 
@@ -31,9 +31,9 @@ After triggering `FirstMessage`, `500ms` later update will be called with `Secon
 Trigger ->
     ( model
     , Delay.sequence
-        [ ( 1000, Millisecond, FirstMessage )
-        , ( 2000, Millisecond, SecondMessage )
-        , ( 1000, Millisecond, ThirdMessage )
+        [ ( 1000, FirstMessage )
+        , ( 2000, SecondMessage )
+        , ( 1000, ThirdMessage )
         ]
     )
 ```
@@ -50,9 +50,9 @@ As a convenience if you'd only like to start a sequence if the model is in a par
 Trigger ->
     ( model
     , Delay.sequenceIf (not model.updating)
-        [ ( 1000, Millisecond, FirstMessage )
-        , ( 2000, Millisecond, SecondMessage )
-        , ( 1000, Millisecond, ThirdMessage )
+        [ ( 1000, FirstMessage )
+        , ( 2000, SecondMessage )
+        , ( 1000, ThirdMessage )
         ]
     )
 ```
@@ -62,11 +62,11 @@ If you'd like all the steps to have the same unit of time, use the `Delay.withUn
 ```elm
 Trigger ->
     ( model
-    , Delay.sequence <|
-        Delay.withUnit Millisecond
-            [ ( 1000, FirstMessage )
-            , ( 2000, SecondMessage )
-            , ( 1000, ThirdMessage )
+    , Delay.sequence 
+        Delay.withUnit Delay.seconds
+            [ ( 1, FirstMessage )
+            , ( 2, SecondMessage )
+            , ( 1, ThirdMessage )
             ]
     )
 ```

examples/src/Main.elm

@@ -45,14 +45,12 @@ init =
 cycleColors : Model -> Cmd Msg
 cycleColors model =
     Delay.sequenceIf (not model.colorCycling)
-        (Delay.withUnit Delay.Millisecond
-            [ ( 0, ColorCycling True )
-            , ( 0, Red )
-            , ( 2000, Green )
-            , ( 2000, Blue )
-            , ( 2000, ColorCycling False )
-            ]
-        )
+        [ ( 0, ColorCycling True )
+        , ( 0, Red )
+        , ( 2000, Green )
+        , ( 2000, Blue )
+        , ( 2000, ColorCycling False )
+        ]