lodash

README

Introduction

lodash-go is goLang methods package, it like javascript's lodash.

go doc reference

Variables

func Chain(input interface{}) *lodash
// init a chain
// example: Chain([]some_struct{...})

func Value(output interface{}) error
// output and bind result
// example: Chain([]some_struct{...}).some_methods().Value(&result)

func Chunk(output interface{}, input interface{}, sliceNum int) (err error)

func Concat(output interface{}, inputs ...interface{}) (err error)
// support concat multi arrays
// example: Concat(&result, []some_struct{...}, []some_struct{...})

func Difference(output interface{}, input interface{}, accessory interface{}) (err error)
// if `input`'s element in `accessory`'， will delete`.
// example: Difference(&result, []some_struct{...}, []some_struct{...})

func Includes(input interface{}, checkValue interface{}) bool
// check `input` contains `checkValue`.

func IncludesBy(input interface{}, iteratee func(interface{}) bool) bool
// check `input` contains match condition value.

func Filter(output interface{}, input interface{}, iteratee func(interface{}) bool) (err error)
// all match condition elements append to result.
// example: Filter(&result,[]some_struct{...}, func(v interface{}) bool { return v.(some_struct).ID > 1 })

func Every(input interface{}, iteratee func(interface{}) bool) bool
// if all `input`'s element can be true(iteratee(element)), will return true.
// example: Every([]some_struct{...}, func(v interface{}) bool { return v.(some_struct).ID > 1 })

func Find(output interface{}, input interface{}, iteratee func(interface{}) bool) (err error)
// return first match condition element.

func IndexOf(input interface{}, iteratee func(interface{}) bool) int
// return first match condition element's index.

func LastIndexOf(input interface{}, iteratee func(interface{}) bool) int
// return last match condition element's index.

func First(output interface{}, input interface{}) (err error)
// return first element. like array[0]

func Last(output interface{}, input interface{}) (err error)
// return last element

func Flatten(output interface{}, input interface{}, level int) (err error)
// level is flatten total, if level <= 0, will flatten forever.

func ForEach(input interface{}, iteratee func(interface{})) (err error)
// just a iterateer.

func Map(output interface{}, input interface{}, iteratee func(interface{}) interface{}) (err error)
// iteratee `input`'s elements and return new value.
// example: Map(&result, []some_struct{...}, func(v interface{}) interface{} {
//   newStruct := some_Struct{}
//   newStruct.ID = v.(some_Struct).ID + 1
//   return newStruct
// })

func GroupBy(output interface{}, input interface{}, iteratee func(interface{}) (key interface{})) (err error)
// group by iteratee function's return value.
// args:
//  type GroupByItem struct {
//    Key    interface{}
//    Values []interface{}
//  }
//  type GroupByRes []GroupByItem

// example:
// groups := lodash.GroupByRes{}
// lodash.GroupBy(&groups, []some_struct{...}, func(i interface{}) (key interface{}) {
//   return i.(some_struct).ID
// })

func Order(output interface{}, input interface{}, keys []string, orders []string) (err error)
// example: Order(&result, []some_struct{...}, []string{`k1`, `k2`}, []string{`asc`, `desc`})
// if len(orders) < len(keys), default `asc`.

func OrderBy(output interface{}, input interface{}, iterateers []func(interface{}) interface{}, orders []string) (err error)
// like Order, iterateers funtion's return values is keys.

func Sort(output interface{}, input interface{}, key string, order string) (err error)
// like Order, but just support one key.

func SortBy(output interface{}, input interface{}, iteratee func(interface{}) interface{}, order string) (err error)
// like Sort, iterate funtion's return value is key.

func Reverse(output interface{}, input interface{}) (err error)
// reverse `input` array.

func Uniq(output interface{}, input interface{}) (err error)
// return Unique elements.

func UniqBy(output interface{}, input interface{}, iteratee func(interface{}) interface{}) (err error)
// return Unique elements by function's return value.

func Union(output interface{}, inputs ...interface{})
// like Concat + Uniq.

func UnionBy(output interface{}, iteratee func(interface{}) interface{}, inputs... interface{})
// like Concat + UniqBy.

func Join(output interface{}, input interface{}, joinStr string) (err error)
// array to string, each element use `joinStr` link.

Demo

package main

import "github.com/guoquanwei/lodash-go"

type User struct {
	ID   int
	Name string
}

func main ()  {
	// simple method
	newUsers := []User{}
	err1 := lodash.Filter(&newUsers, []User{{ID: 1}, {ID: 2}, func(i interface{}) bool {
		return i.(User).ID > 1
	}})

	// multi methods use lodash.Chain()
	user := User{}
	err2 := lodash.Chain([]User{{ID: 1}, {ID: 2}).Filter(func(i interface{}) bool {
		return i.(User).ID > 1
	}}).First().Value(&user)
	
}

Documentation

Index

• Variables
• func Avg(input interface{}) (num float64, err error)
• func Chain(input interface{}) *lodash
• func CheckKindErr(funcName string, isChain bool, outputKind string, inputKind string) error
• func Chunk(output interface{}, input interface{}, sliceNum int) (err error)
• func Concat(output interface{}, inputs ...interface{}) (err error)
• func Difference(output interface{}, input interface{}, accessory interface{}) (err error)
• func Every(input interface{}, iteratee func(interface{}) bool) bool
• func Filter(output interface{}, input interface{}, iteratee func(interface{}) bool) (err error)
• func Find(output interface{}, input interface{}, iteratee func(interface{}) bool) (err error)
• func First(output interface{}, input interface{}) (err error)
• func Flatten(output interface{}, input interface{}, level int) (err error)
• func ForEach(input interface{}, iteratee func(interface{})) (err error)
• func GroupBy(output interface{}, input interface{}, ...) (err error)
• func Includes(input interface{}, checkValue interface{}) bool
• func IncludesBy(input interface{}, iteratee func(interface{}) bool) bool
• func IndexOf(input interface{}, iteratee func(interface{}) bool) int
• func Join(output interface{}, input interface{}, joinStr string) (err error)
• func Last(output interface{}, input interface{}) (err error)
• func LastIndexOf(input interface{}, iteratee func(interface{}) bool) int
• func Map(output interface{}, input interface{}, iteratee func(interface{}) interface{}) (err error)
• func Max(input interface{}) (num float64, err error)
• func Min(input interface{}) (num float64, err error)
• func Order(output interface{}, input interface{}, keys []string, orders []string) (err error)
• func OrderBy(output interface{}, input interface{}, ...) (err error)
• func OrderByLess(less ...LessFunc) *multiSorter
• func Reverse(output interface{}, input interface{}) (err error)
• func Sort(output interface{}, input interface{}, key string, order string) (err error)
• func SortBy(output interface{}, input interface{}, ...) (err error)
• func Sum(input interface{}) (num float64, err error)
• func Union(output interface{}, inputs ...interface{})
• func UnionBy(output interface{}, iteratee func(interface{}) interface{}, ...)
• func Uniq(output interface{}, input interface{}) (err error)
• func UniqBy(output interface{}, input interface{}, iteratee func(interface{}) interface{}) (err error)
• type GroupByItem
• type GroupByRes
• type LessFunc

Variables

var (
	ErrNotFound       = errors.New("record not found")
	ErrNotImplemented = errors.New("not implemented")
	ErrInvalidData    = errors.New("invalid data")
	ErrInvalidField   = errors.New("invalid field")
	ErrInvalidValue   = errors.New("invalid value")
)

var ReflectArrayTypes = []string{`array`, `slice`, `map`}

var ReflectFloatTypes = []string{`float32`, `float64`}

var ReflectIntTypes = []string{`int`, `int8`, `int16`, `int32`, `int64`}

Reflect Types Bool: "bool", Int: "int", Int8: "int8", Int16: "int16", Int32: "int32", Int64: "int64", Uint: "uint", Uint8: "uint8", Uint16: "uint16", Uint32: "uint32", Uint64: "uint64", Uintptr: "uintptr", Float32: "float32", Float64: "float64", Complex64: "complex64", Complex128: "complex128", Array: "array", Chan: "chan", Func: "func", Interface: "interface", Map: "map", Ptr: "ptr", Slice: "slice", String: "string", Struct: "struct", UnsafePointer: "unsafe.Pointer",

var ReflectUIntTypes = []string{`uint`, `uint8`, `uint16`, `uint32`, `uint64`}

Functions

func Avg

func Avg(input interface{}) (num float64, err error)

func Chain

func Chain(input interface{}) *lodash

func CheckKindErr

func CheckKindErr(funcName string, isChain bool, outputKind string, inputKind string) error

func Chunk

func Chunk(output interface{}, input interface{}, sliceNum int) (err error)

func Concat

func Concat(output interface{}, inputs ...interface{}) (err error)

func Difference

func Difference(output interface{}, input interface{}, accessory interface{}) (err error)

func Every

func Every(input interface{}, iteratee func(interface{}) bool) bool

func Filter

func Filter(output interface{}, input interface{}, iteratee func(interface{}) bool) (err error)

func Find

func Find(output interface{}, input interface{}, iteratee func(interface{}) bool) (err error)

func First

func First(output interface{}, input interface{}) (err error)

func Flatten

func Flatten(output interface{}, input interface{}, level int) (err error)

if level <= 0, flatten forever.

func ForEach

func ForEach(input interface{}, iteratee func(interface{})) (err error)

func GroupBy

func GroupBy(output interface{}, input interface{}, iteratee func(interface{}) (key interface{})) (err error)

output type must like []groupByObj.

func Includes

func Includes(input interface{}, checkValue interface{}) bool

func IncludesBy

func IncludesBy(input interface{}, iteratee func(interface{}) bool) bool

func IndexOf

func IndexOf(input interface{}, iteratee func(interface{}) bool) int

func Join

func Join(output interface{}, input interface{}, joinStr string) (err error)

func Last

func Last(output interface{}, input interface{}) (err error)

func LastIndexOf

func LastIndexOf(input interface{}, iteratee func(interface{}) bool) int

func Map

func Map(output interface{}, input interface{}, iteratee func(interface{}) interface{}) (err error)

func Max

func Max(input interface{}) (num float64, err error)

func Min

func Min(input interface{}) (num float64, err error)

func Order

func Order(output interface{}, input interface{}, keys []string, orders []string) (err error)

func OrderBy

func OrderBy(output interface{}, input interface{}, valueFunctions []func(interface{}) interface{}, orders []string) (err error)

OrderBy 适用于复杂类型

func OrderByLess

func OrderByLess(less ...LessFunc) *multiSorter

func Reverse

func Reverse(output interface{}, input interface{}) (err error)

func Sort

func Sort(output interface{}, input interface{}, key string, order string) (err error)

func SortBy

func SortBy(output interface{}, input interface{}, valueFunction func(interface{}) interface{}, order string) (err error)

func Sum

func Sum(input interface{}) (num float64, err error)

func Union

func Union(output interface{}, inputs ...interface{})

func UnionBy

func UnionBy(output interface{}, iteratee func(interface{}) interface{}, inputs ...interface{})

func Uniq

func Uniq(output interface{}, input interface{}) (err error)

func UniqBy

func UniqBy(output interface{}, input interface{}, iteratee func(interface{}) interface{}) (err error)

Types

type GroupByItem

type GroupByItem struct {
	Key    interface{}
	Values []interface{}
}

type GroupByRes

type GroupByRes []GroupByItem

type LessFunc

type LessFunc func(p, q interface{}) bool