README
¶
snowflake
snowflake is a golang library for parsing snowflake IDs from discord.
This package provides a custom snowflake.ID type which has various utility methods for parsing discord snowflakes.
Installing
go get github.com/snekROmonoro/snowflake
Usage
id := snowflake.ID(123456789012345678)
// deconstructs the snowflake ID into its components timestamp, worker ID, process ID, and increment
id.Deconstruct()
// the time.Time when the snowflake ID was generated
id.Time()
// the worker ID which the snowflake ID was generated
id.WorkerID()
// the process ID which the snowflake ID was generated
id.ProcessID()
// tje sequence when the snowflake ID was generated
id.Sequence()
// returns the string representation of the snowflake ID
id.String()
// returns a new snowflake ID with worker ID, process ID, and sequence set to 0
// this can be used for various pagination requests to the discord api
id := New(time.Now())
// returns a snowflake ID from an environment variable
id := GetEnv("guild_id")
// returns a snowflake ID from an environment variable and a bool indicating if the key was found
id, found := LookupEnv("guild_id")
// returns the string as a snowflake ID or an error
id, err := Parse("123456789012345678")
// returns the string as a snowflake ID or panics if an error occurs
id := MustParse("123456789012345678")
License
Distributed under the . See LICENSE for more information.
Forked from disgo's snowflake.
Documentation
¶
Index ¶
Constants ¶
const Epoch = 1420070400000
Epoch is the discord epoch in milliseconds.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DeconstructedSnowflake ¶
type DeconstructedSnowflake struct {
Time time.Time
WorkerID uint8
ProcessID uint8
Sequence uint16
}
DeconstructedSnowflake contains the properties used by Discord for each snowflake ID.
type ID ¶
type ID uint64
ID represents a unique snowflake ID.
func GetEnv ¶
GetEnv returns the value of the environment variable named by the key and parses it as a snowflake. returns ID(0) if the environment variable is not set.
func LookupEnv ¶
LookupEnv returns the value of the environment variable named by the key and parses it as a snowflake. returns false if the environment variable is not set.
func MustParse ¶
MustParse parses a string into a snowflake ID and panics on error. returns ID(0) if the string is "null"
func New ¶
New creates a new snowflake ID from the provided timestamp with worker id and sequence 0.
func (ID) Deconstruct ¶
func (id ID) Deconstruct() DeconstructedSnowflake
Deconstruct returns DeconstructedID (https://discord.com/developers/docs/reference#snowflakes-snowflake-id-format-structure-left-to-right).
func (ID) MarshalJSON ¶
MarshalJSON marshals the snowflake ID into a JSON string.
func (*ID) UnmarshalJSON ¶
UnmarshalJSON unmarshals the snowflake ID from a JSON string.
Source Files