Editing Module:TwitterSnowflake/doc

{{Module rating|release}}
{{Module rating|protected}}
{{high use}}
{{Lua sidebar}}
This is a Lua module to translate [[Snowflake ID|snowflakes]] from platforms such as [[Twitter]] and [[Discord (software)|Discord]] to timestamps. This can be used for automatically generating dates for templates like {{t|cite tweet}}.

===Usage===
There is one required parameter: {{para|id_str}}, which must be the snowflake ID of the tweet. For example, <code>1345021162959503360</code>.

<code><nowiki>{{#invoke:TwitterSnowflake|snowflakeToDate|id_str=1345021162959503360}}</nowiki></code> returns {{#invoke:TwitterSnowflake|snowflakeToDate|id_str=1345021162959503360}}.

To specify the date format, use {{para|format}}.

<code><nowiki>{{#invoke:TwitterSnowflake|snowflakeToDate|id_str=1345021162959503360|format=%e %B %Y}}</nowiki></code> returns {{#invoke:TwitterSnowflake|snowflakeToDate|id_str=1345021162959503360|format=%e %B %Y}} — useful to specify, especially for use in [[Help:CS1|CS1 citations]], in case the default date format would change in the future (though unlikely).

====Custom epoch====

By default, the [[epoch]] used is that of Twitter. To specify a different epoch, such as that of Twitter, use {{para|epoch}}. The epoch of Discord is <code>1420070400</code>

<code><nowiki>{{#invoke:TwitterSnowflake|snowflakeToDate|id_str=797545051047460888|epoch=1420070400}}</nowiki></code> returns {{#invoke:TwitterSnowflake|snowflakeToDate|id_str=797545051047460888|epoch=1420070400}}.

===See also===
*[[Template:TwitterSnowflake]]
*[[Template:Cite tweet]]
*[[Snowflake ID]]