README
¶
snowflake
snowflake is a golang library for parsing snowflake IDs from discord.
This package provides a custom snowflake type which has various utility methods for parsing snowflake IDs.
Installing
go get github.com/DisgoOrg/snowflake
Usage
id := Snowflake("123456789012345678")
// deconstructs the snowflake ID into its components timestamp, worker ID, process ID, and increment
id.Deconstruct()
// time.Time when the snowflake was generated
id.Time()
// returns the string representation of the snowflake ID
id.String()
// returns the int64 representation of the snowflake ID
id.Int64()
// returns a new snowflake with worker ID, process ID, and increment set to 0
// this can be used for various pagination requests to the discord api
id = NewSnowflake(time.Now())
// returns the fmt.Stringer as a Snowflake
id = ParseString(...)
// returns the int64 as a Snowflake
id = ParseInt64(123456789012345678)
// returns the uint64 as a Snowflake
id = ParseUInt64(123456789012345678)
// returns a snowflake from an environment variable
id = GetSnowflakeEnv("guild_id")
License
Distributed under the . See LICENSE for more information.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var Epoch int64 = 1420070400000
Functions ¶
This section is empty.
Types ¶
type DeconstructedSnowflake ¶
type DeconstructedSnowflake struct {
Time time.Time
WorkerID int64
ProcessID int64
Increment int64
}
DeconstructedSnowflake contains the properties used by Discord for each CommandID
type Snowflake ¶
type Snowflake string
Snowflake is a general utility type around discord's IDs
func GetSnowflakeEnv ¶ added in v1.0.1
GetSnowflakeEnv returns a new Snowflake from an environment variable
func NewSnowflake ¶
NewSnowflake returns a new Snowflake based on the given time.Time
func ParseInt64 ¶ added in v1.0.3
ParseInt64 parses an int64 into a Snowflake
func ParseString ¶ added in v1.0.4
ParseString parses a fmt.Stringer into a Snowflake
func ParseUInt64 ¶ added in v1.0.3
ParseUInt64 parses an uint64 into a Snowflake
func (Snowflake) Deconstruct ¶
func (s Snowflake) Deconstruct() DeconstructedSnowflake
Deconstruct returns DeconstructedSnowflake (https://discord.com/developers/docs/reference#snowflakes-snowflake-id-format-structure-left-to-right)
Source Files