mmzk-typeid 0.5.0.0 → 0.5.0.1

raw patch · 3 files changed

+11/−6 lines, 3 filesPVP ok

version bump matches the API change (PVP)

API changes (from Hackage documentation)

Files

• CHANGELOG.md +5/−0
• README.md +5/−5
• mmzk-typeid.cabal +1/−1

@@ -1,6 +1,11 @@ # Revision history for mmzk-typeid  +## 0.5.0.1 --2023-9-18++* Fix bad links in the documentation.++ ## 0.5.0.0 -- 2023-08-31  * Support `TypeID` and `KindID` with `UUID` suffixes of version 5.

@@ -21,7 +21,7 @@ In addition to the features provided by [TypeID](https://github.com/jetpack-io/typeid), this implementation also supports:  1. Generating TypeIDs in a batch. They are guaranteed to have the same timestamp (up to the first 32768 ids) and of ascending order;-2. Encoding the prefix in the [type level](src/Data/KindID.hs), so that if you accidentally pass in a wrong prefix, the code won't compile, avoiding the need for runtime checks.+2. Encoding the prefix in the [type level](https://hackage.haskell.org/package/mmzk-typeid/docs/Data-KindID.html), so that if you accidentally pass in a wrong prefix, the code won't compile, avoiding the need for runtime checks. 3. Support TypeID with other UUID versions. Currently v7 (default) and v4 are supported.  ## Quick start@@ -59,7 +59,7 @@     Right typeID -> print typeID ``` -For a full list of functions on `TypeID`, see [Data.TypeID](src/Data/TypeID.hs).+For a full list of functions on `TypeID`, see [Data.TypeID](https://hackage.haskell.org/package/mmzk-typeid/docs/Data-TypeID.html).  ## More Usages @@ -141,7 +141,7 @@     Right kindID -> print kindID ``` -For a full list of functions on `KindID`, see [Data.KindID](src/Data/KindID.hs).+For a full list of functions on `KindID`, see [Data.KindID](https://hackage.haskell.org/package/mmzk-typeid/docs/Data-KindID.html).  ### Functions with More General Types `TypeID` and `KindID` shares many functions with the same name and functionality. So far, we are using qualified imports to diffentiate them (*e.g* `KID.fromString` and `TID.fromString`). Alternatively, we can use the methods of `IDConv` to use the same functions for both `TypeID` and `KindID`.@@ -180,7 +180,7 @@  Note that with the class methods, the type application with `Symbol` no longer works as the full type must be provided. For example, `string2ID @"mmzk" "mmzk_01h455vb4pex5vsknk084sn02q"` will not compile. -For a full list of these functions, see [Data.TypeID.Class](src/Data/TypeID/Class.hs).+For a full list of these functions, see [Data.TypeID.Class](https://hackage.haskell.org/package/mmzk-typeid/docs/Data-TypeID-Class.html).  ### KindID with Data Kinds Instead of using raw `Symbol`s as `KindID` prefixes, we can also define our custom data type for better semantics.@@ -219,7 +219,7 @@   -- ... ``` -For more information, see [Data.KindID.Class](src/Data/KindID/Class.hs).+For more information, see [Data.KindID.Class]([src/Data/KindID/Class.hs](https://hackage.haskell.org/package/mmzk-typeid/docs/Data-KindID-Class.html)).  ## Note Not explicitly exported functions are considered internal and are subjected to changes.

@@ -1,6 +1,6 @@ cabal-version:      2.4 name:               mmzk-typeid-version:            0.5.0.0+version:            0.5.0.1  synopsis:           A TypeID implementation for Haskell description: