Skip to content

Commit

Permalink
Added C# docs
Browse files Browse the repository at this point in the history
  • Loading branch information
joente committed Dec 14, 2023
1 parent 127d118 commit 72b622b
Show file tree
Hide file tree
Showing 369 changed files with 365 additions and 368 deletions.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion v1/content/collection-api/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Collection API"
weight: 198
weight: 196
chapter: true
---

Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/alt_raise.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "alt_raise"
weight: 199
weight: 197
---

This function will try a statement. If the statement is successful it will just return the result but in case of an error, it will re-raise the error using a given error code.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/assert.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "assert"
weight: 200
weight: 198
---

Raises an [assert_err()](../../errors/assert_err) if the specified expression evaluates to `false`.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/base64_decode.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "base64_decode"
weight: 201
weight: 199
---

Decode a Base64 encoded string.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/base64_encode.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "base64_encode"
weight: 202
weight: 200
---

Encode a [str](../../data-types/str) or [bytes](../../data-types/bytes) value using Base64.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/bool.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "bool"
weight: 203
weight: 201
---

Returns a [bool](../../data-types/bool) from a specified value.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/bytes.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "bytes"
weight: 204
weight: 202
---

Convert a value to a byte sequence. If no value is given, an empty byte sequence is returned.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/change_id.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "change_id"
weight: 205
weight: 203
---

Returns the current change Id for the running query. The return value will be `nil` if the query does not require a *change*.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/closure.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "closure"
weight: 206
weight: 204
---

Returns an [closure](../../data-types/closure) from a given string.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/datetime.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "datetime"
weight: 207
weight: 205
---

Returns a [datetime](../../data-types/datetime) depending on some optional values.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/deep.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "deep"
weight: 208
weight: 206
---

Set or return the current `deep` value for the **running query**. The deep value indicates how far down the result of a query is returned. For example, *thing1* may contain a *thing2* that contains a *thing3*. A deep value of 1 would only show the content of *thing1* and a deep value of 3 will go as deep as the content of *thing3*. ThingsDB allows *deep* to have a value between `0` and `127`.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/del_enum.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "del_enum"
weight: 209
weight: 207
---

Deletes an existing [enumerator type](../../data-types/enum).
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/del_type.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "del_type"
weight: 210
weight: 208
---

Deletes an existing [Type](../../overview/type).
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/enum.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "enum"
weight: 211
weight: 209
---

Returns a [enum](../../data-types/enum) member from a given value.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/enum_info.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "enum_info"
weight: 212
weight: 210
---

Returns information about a given [enumeration type](../../data-types/enum).
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/enum_map.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "enum_map"
weight: 213
weight: 211
---

Returns a thing with key/value pairs for all the members of a given enum.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/enums_info.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "enums_info"
weight: 214
weight: 212
---

Returns [enumeration type](../../data-types/enum) information about all the enum's within a collection scope.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/err.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "err"
weight: 215
weight: 213
---

Returns an [error](../../data-types/error).
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/float.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "float"
weight: 216
weight: 214
---

Returns a [float](../../data-types/float) from a specified value.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/future.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "future"
weight: 217
weight: 215
---

Returns a [future](../../data-types/future). It is *not* possible to assign a future to
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/has_enum.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "has_enum"
weight: 218
weight: 216
---

Determines if a [enumerator type](../../data-types/enum) exists in the current `@collection` scope.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/has_type.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "has_type"
weight: 219
weight: 217
---

Determines if a [Type](../../overview/type) exists in the current `@collection` scope.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/int.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "int"
weight: 220
weight: 218
---

Returns an [int](../../data-types/int) from a specified value.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/is/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "is..."
weight: 221
weight: 219
---

There are many functions in ThingsDB to check if a value is compatible with some specification.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/is/is_array.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "is_array"
weight: 222
weight: 220
---

This function determines whether the provided value is of type [list](../../../data-types/list) or [tuple](../../../data-types/tuple) or not. The functions [is_list](../../../collection-api/is/is_list) and
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/is/is_ascii.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "is_ascii"
weight: 223
weight: 221
---

This function determines whether the provided value is of
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/is/is_bool.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "is_bool"
weight: 224
weight: 222
---

This function determines whether the provided value is a [bool](../../../data-types/bool) or not.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/is/is_bytes.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "is_bytes"
weight: 225
weight: 223
---

This function determines whether the provided value is of type [bytes](../../../data-types/bytes) or not.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/is/is_closure.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "is_closure"
weight: 226
weight: 224
---

This function determines whether the provided value is a [closure](../../../data-types/closure) or not.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/is/is_datetime.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "is_datetime"
weight: 227
weight: 225
---

This function determines whether the provided value is of
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/is/is_email.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "is_email"
weight: 228
weight: 226
---

This function determines whether the provided value is of
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/is/is_enum.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "is_enum"
weight: 229
weight: 227
---

This function determines whether the provided value is an [enumeration type](../../../data-types/enum) member or not.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/is/is_err.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "is_err"
weight: 230
weight: 228
---

This function determines whether the provided value is a [error](../../../data-types/error) or not.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/is/is_float.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "is_float"
weight: 231
weight: 229
---

This function determines whether the provided value is a [floating point](../../../data-types/float) value or not.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/is/is_future.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "is_future"
weight: 232
weight: 230
---

This function determines whether the provided value is a [future](../../../data-types/future) value or not.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/is/is_inf.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "is_inf"
weight: 233
weight: 231
---

This function determines whether the provided value is a positive or negative *infinity*.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/is/is_int.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "is_int"
weight: 234
weight: 232
---

This function determines whether the provided value is an [integer](../../../data-types/int) or not.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/is/is_list.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "is_list"
weight: 235
weight: 233
---

This function determines whether the provided value is a [list](../../../data-types/list) or not.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/is/is_mpdata.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "is_mpdata"
weight: 236
weight: 234
---

This function determines whether the provided value is of type [mpdata](../../../data-types/) or not.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/is/is_nan.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "is_nan"
weight: 237
weight: 235
---

This function determines whether the provided value is not a number.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/is/is_nil.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "is_nil"
weight: 238
weight: 236
---

This function determines whether the provided value is [nil](../../../data-types/nil).
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/is/is_raw.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "is_raw"
weight: 239
weight: 237
---

This function determines whether the provided value is of type [str](../../../data-types/str) *or* [bytes](../../../data-types/bytes).
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/is/is_regex.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "is_regex"
weight: 240
weight: 238
---

This function determines whether the provided value is of type [regex](../../../data-types/regex) or not.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/is/is_room.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "is_room"
weight: 241
weight: 239
---

This function determines whether the provided value is a [room](../../../data-types/room) or not.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/is/is_set.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "is_set"
weight: 242
weight: 240
---

This function determines whether the provided value is a [set](../../../data-types/set) or not.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/is/is_str.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "is_str"
weight: 243
weight: 241
---

This function determines whether the provided value is of type [str](../../../data-types/str).
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/is/is_task.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "is_task"
weight: 244
weight: 242
---

This function determines whether the provided value is a [task](../../../data-types/task) or not.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/is/is_tel.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "is_tel"
weight: 245
weight: 243
---

This function determines whether the provided value is of
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/is/is_thing.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "is_thing"
weight: 246
weight: 244
---

This function determines whether the provided value is a [thing](../../../data-types/thing) or not.
Expand Down
2 changes: 1 addition & 1 deletion v1/content/collection-api/is/is_time_zone.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "is_time_zone"
weight: 247
weight: 245
---

This function determines whether the provided value is of
Expand Down
Loading

0 comments on commit 72b622b

Please sign in to comment.