Categorygithub.com/threefoldtech/tfexplorerschema
package
0.6.1
Repository: https://github.com/threefoldtech/tfexplorer.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
18
Dependents
27
Files
876 SLOC

# README

About

Go library to work with jxs schema from Go. The library basically does two things

  • Implement all the native schema/jsx types (string, numeric, date, etc...)
  • Generate Go types from schema files. The types later can be used to do calls to services that expect schema objects.

Reference

Schema docs is defined here.

How to use

Please check example here

# Functions

GenerateGolang generate type stubs for Go from schema.
MustParseIPCidr prases ipcidr, panics if invalid.
MustParseIPRange prases iprange, panics if invalid.
New reads the schema and return schema description objects.
ParseIPCidr parse iprange.
ParseIPRange parse iprange.

# Constants

List of all the supported JSX types.
List of all the supported JSX types.
List of all the supported JSX types.
List of all the supported JSX types.
List of all the supported JSX types.
List of all the supported JSX types.
List of all the supported JSX types.
List of all the supported JSX types.
List of all the supported JSX types.
List of all the supported JSX types.
List of all the supported JSX types.
List of all the supported JSX types.
List of all the supported JSX types.
List of all the supported JSX types.
List of all the supported JSX types.
List of all the supported JSX types.
List of all the supported JSX types.
List of all the supported JSX types.
List of all the supported JSX types.
List of all the supported JSX types.
SchemaQual path to schema package.
List of all the supported JSX types.
List of all the supported JSX types.
URL directive.
List of all the supported JSX types.
List of all the supported JSX types.

# Structs

Date a jumpscale date wrapper.
Directive is a piece of information attached to a schema object.
IP schema type.
IPCidr type is improved version of IPRange which can marshal/unmarshal itself to BSON for database readability.
IPRange type (deprecated, please check IPCidr type) this is kept for backward compatibility for objects that are already in the database.
MacAddress type.
Object defines a schema object.
Property defines a schema property.
Type holds type information for a property.

# Type aliases

Email type.
ID object id.
Kind defines the kind of a type.
Numeric type.
Schema is a container for all objects defined in the source.