Editing Module:Effective protection expiry/doc

{{Module rating |protected <!-- Values:  pre-alpha • alpha • beta • release • protected  --  If a rating not needed/relevant, delete this template call -->}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->

This module provides a way to retrieve the expiry of a restriction over a given action on a page.

== Usage ==
This module will use up to 1 expensive parser function call each time it is ran. It will not use any if [[Module:Effective protection level]] was already called.

=== From other modules ===
To load this module:
<syntaxhighlight lang="lua">
local effectiveProtectionExpiry = require('Module:Effective protection expiry')._main
</syntaxhighlight>

The function accepts two parameters. The first is a string containing the action to check, which must be one of "edit", "create", "move", "upload", or "autoreview". The second is optional, and can either be the name of the page to check, or a title returned from the mw.title functions. If the second parameter is omitted, the page being displayed is the one checked against.

The return value is either a date string in <code>YY-MM-DDThh:mm:ss</code> format, or one of the following strings:
* <code>infinity</code> - for pages protected indefinitely, or pages which exist and are not protected
* <code>unknown</code> - for pages where the expiry is unknown,  or pages which do not exist and are not protected

Note that if an existing page is not protected for the requested action, this will return 'infinity'. You need to check separately with [[Module:Effective protection level]].

=== From wikitext ===
The parameters are the same as when it is called directly.
 {{tlinv|Effective protection expiry|''action''|''title''}}

== See also ==
* [[Module:Effective protection level]]
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!-- Categories below this line, please; interwikis at Wikidata -->

}}</includeonly>