summaryrefslogtreecommitdiff
path: root/core/api-common.rst
diff options
context:
space:
mode:
authorÖzgür Kesim <oec-taler@kesim.org>2021-10-20 10:58:14 +0200
committerÖzgür Kesim <oec-taler@kesim.org>2021-10-20 10:58:14 +0200
commit4b2bbd5e6b32b6cf92867f9ed5d9f66a4564f03e (patch)
tree0faa4e037dd550bde7c9ee7435778222e2e703ce /core/api-common.rst
parent86d83d3ae108158c0ec5489745e90c9bf01d6b8c (diff)
downloaddocs-4b2bbd5e6b32b6cf92867f9ed5d9f66a4564f03e.tar.gz
docs-4b2bbd5e6b32b6cf92867f9ed5d9f66a4564f03e.tar.bz2
docs-4b2bbd5e6b32b6cf92867f9ed5d9f66a4564f03e.zip
added Age and Version types
Diffstat (limited to 'core/api-common.rst')
-rw-r--r--core/api-common.rst31
1 files changed, 31 insertions, 0 deletions
diff --git a/core/api-common.rst b/core/api-common.rst
index 7ee4769f..155857c0 100644
--- a/core/api-common.rst
+++ b/core/api-common.rst
@@ -275,6 +275,37 @@ Integers
// JavaScript numbers restricted to integers.
type Integer = number;
+Ages
+^^^^
+
+.. ts:def:: Age
+
+ // An age is an integer between 0 and 255 measured in years.
+ type Age = number;
+
+Versions
+^^^^^^^^
+
+We use the type ``LibtoolVersion`` in the design documents to refer to a string
+that represents a version with the semantic as defined by
+`libtool <https://www.gnu.org/software/libtool/manual/html_node/Libtool-versioning.html>`__.
+
+.. ts:def:: LibtoolVersion
+
+ // Version information in libtool version format and semantics
+ // current[:revision[:age]], f.e. "1", "2:0" or "3:1:2".
+ // see https://www.gnu.org/software/libtool/manual/html_node/Libtool-versioning.html.
+ type LibtoolVersion = string;
+
+We use the type ``SemVer`` to refer to a string that represents a version with
+the semantic as defined by `semantic versioning <https://semver.org/>`__.
+
+.. ts:def:: SemVer
+
+ // Version information in semantic versioning format and semantics,
+ // like "X.Z.Y", see https://semver.org/.
+ type SemVer = string;
+
Objects
^^^^^^^