typ3r

package module
v0.0.0-...-bf4b532 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 31, 2017 License: MIT Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

type Client struct {
	Config *Config
}

Client represents a typ3r client

func (*Client) ListNotes

func (c *Client) ListNotes(offset int, limit int, query string) (notes []Note, err error)

ListNotes will return a list of the user notes

func (*Client) NewNote

func (c *Client) NewNote(text string) (*Note, error)

func (*Client) UpdateNote

func (c *Client) UpdateNote(id int, text string) error

type Config

type Config struct {
	// contains filtered or unexported fields
}

Config holds all typ3r's client user configuration

func LoadConfig

func LoadConfig() (cfg *Config, err error)

LoadConfig loads a typ3r's client user configuration

type Note

type Note struct {
	ID       string    `json:"id"`
	UserID   string    `json:"user_id"`
	Card     string    `json:"card"`
	Ts       Timestamp `json:"ts"`
	Created  Timestamp `json:"created"`
	Text     string    `json:"text"`
	ShareID  string    `json:"shareid"`
	Visits   string    `json:"visits"`
	Tasks    []Task    `json:"tasks"`
	Snippets []Snippet `json:"snippets"`
}

Note is the basic entity in typ3r

type Snippet

type Snippet struct {
}

Snippet holds a script or snippet of code

type Task

type Task struct {
}

Task is a bummer

type Timestamp

type Timestamp time.Time

Timestamp is an alias to provide unmarshalling

func (*Timestamp) UnmarshalJSON

func (ct *Timestamp) UnmarshalJSON(b []byte) (err error)

Directories

Path Synopsis
cmd
typ3r command

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL