Wikipedia:Lua/Modul/JSONutil/en - Versionsgeschichte

PerfektesChaos: +

2020-11-24T14:32:30Z

PerfektesChaos: update

2019-07-22T09:55:52Z

update

← Nächstältere Version		Version vom 22. Juli 2019, 11:55 Uhr
Zeile 9:		Zeile 9:
	<noinclude>__TOC__</noinclude>		<noinclude>__TOC__</noinclude>
	== {{Anker\|template}} Functions for templates ==		== {{Anker\|template}} Functions for templates ==
	; failsafe ~~{{Anker\|~~failsafe}}		; <span id="failsafe">failsafe</span>
	: Version ID: <code>{{#invoke:JSONutil\|failsafe}}</code>		: Version ID: <code>{{#invoke:JSONutil\|failsafe}}</code>
	: optional parameter <code>1</code> – required version, or keyword <code>wikidata</code>		: optional parameter <code>1</code> – required version, or keyword <code>wikidata</code> or keyword <code>~</code>
	: ''Returns:''		: ''Returns:''
	:* (empty), if minimal version condition not matched		:* ''empty'', if minimal version condition not matched
	:* local version otherwise, or registered on Wikidata (<code>{{#invoke:JSONutil\|failsafe\|wikidata}}</code>) when <code>wikidata</code>		:* local version otherwise, or registered version on Wikidata (<code>{{#invoke:JSONutil\|failsafe\|wikidata}}</code>) when keyword <code>wikidata</code>
			:* ''empty'', if keyword <code>~</code> and a registered version on Wikidata is the same as local; otherwise local version ID (<code>{{#invoke:JSONutil\|failsafe\|~}}</code>)
	</onlyinclude>		</onlyinclude>
	== {{Anker\|Lua}} Functions for Lua modules (API) ==		== {{Anker\|Lua}} Functions for Lua modules (API) ==

PerfektesChaos: m

2019-06-19T14:22:28Z

← Nächstältere Version		Version vom 19. Juni 2019, 16:22 Uhr
Zeile 75:		Zeile 75:

	== See also ==		== See also ==
	* [[:en:User:PerfektesChaos/js/jsonDebug\|jsonDebug@PerfektesChaos]] – ~~Benutzerskript~~ ~~zur~~ ~~detaillierteren~~ ~~Analyse~~ ~~fataler~~ ~~Fehler~~		* [[:en:User:PerfektesChaos/js/jsonDebug\|jsonDebug@PerfektesChaos]] – User JavaScript for detailed analysis of fatal JSON errors
	</onlyinclude>		</onlyinclude>
	[[Kategorie:Wikipedia:Lua/Modul/Dokumentation\|JSONutil/en]]		[[Kategorie:Wikipedia:Lua/Modul/Dokumentation\|JSONutil/en]]

PerfektesChaos: k

2019-06-18T15:42:49Z

← Nächstältere Version		Version vom 18. Juni 2019, 17:42 Uhr
Zeile 23:		Zeile 23:
	JSONutil = JSONutil.JSONutil()		JSONutil = JSONutil.JSONutil()
	else		else
	-- failure; ~~WLink~~ is the error message		-- failure; JSONutil is the error message
	return "<span class=\"error\">" .. JSONutil .. "</span>"		return "<span class=\"error\">" .. JSONutil .. "</span>"
	end		end

PerfektesChaos: Setup

2019-06-07T14:36:35Z

Setup

Neue Seite

{{LuaModuleDoc}}
<onlyinclude>
'''<code>JSONutil</code>''' – Module with functions for preparation and analysis of [[JavaScript Object Notation|JSON]] code strings.

Line breaks and tabulators within string values will be accepted and converted.

Rather than a global “Invalid” message it will be tried to detect some typical errors and communicate them together with context.

<noinclude>__TOC__</noinclude>
== {{Anker|template}} Functions for templates ==
; failsafe {{Anker|failsafe}}
: Version ID: <code>{{#invoke:JSONutil|failsafe}}</code>
: optional parameter <code>1</code> – required version, or keyword <code>wikidata</code>
: ''Returns:''
:* (empty), if minimal version condition not matched
:* local version otherwise, or registered on Wikidata (<code>{{#invoke:JSONutil|failsafe|wikidata}}</code>) when <code>wikidata</code>
</onlyinclude>
== {{Anker|Lua}} Functions for Lua modules (API) ==
All functions described above can be used by other modules:
<syntaxhighlight lang="lua">
local lucky, JSONutil = pcall( require, "Module:JSONutil" )
if type( JSONutil ) == "table" then
JSONutil = JSONutil.JSONutil()
else
-- failure; WLink is the error message
return "" .. JSONutil .. ""
end
</syntaxhighlight>
Subsequently there are available:
; JSONutil.[[#failsafe|failsafe]](atleast)
: Version ID
:* atleast ''optional'' ''nil'' or required version or <code>"wikidata"</code>
: returns: ''string'' or ''false''
; JSONutil.fair(apply)
: Reduce enhanced JSON data to strict JSON and analyse for errors.
:* apply ''string'' with JSON code
: returns: ''string'' or ''false''
:# ''string'' with error keyword, or <code>false</code> if no complaints.
:# ''string'' with error context, or clean JSON code if no complaints.
; JSONutil.fault(alert, add, adapt)
: Retrieve formatted message in best language
:* alert ''string'' with error keyword
:* add ''optional'' ''string'' with error context
:* adapt ''optional'' – [[#adapt|language preferences]]
: returns: ''string'' with HTML error message.
; JSONutil.fetch(apply, always, adapt)
: Convert JSON robust into Lua
:* apply ''string'' with JSON code
:* always ''optional'' <code>true</code>, if always preemptive test for free line format and strict JSON code being performed Meaningful for migration HHVM→PHP7 2019 to discover problems also in HHVM mode.
:* adapt ''optional'' – [[#adapt|language preferences]]
: returns: ''string'' or ''table''
:* ''string'' with HTML error message in best language.
:* ''table'' with JSON data.

== {{Anker|adapt}} Language preferences ==
The argument <code>adapt</code> provides adaption of message language and might be one of these types:
* <code>function</code> – Callback
** Return value is best message text
** Two arguments:
**# ''table'', with mapping: language code → message text
**# ''string'', optional, with message text if ''table'' fails
** [[../../Multilingual/en#i18n()|i18n@Multilingual]] would work
* <code>string</code> – space-separated list of preferred language codes
* false/nil – project language, else English

== Dependencies ==
''None''.
<onlyinclude>
== Usage ==
Useful for Lua programming only.

== Internationalisation ==
* [[commons:Data:I18n/Module:JSONutil.tab]] – Text elements
* Error messages will be shown in user or project language, if available.

== See also ==
* [[:en:User:PerfektesChaos/js/jsonDebug|jsonDebug@PerfektesChaos]] – Benutzerskript zur detaillierteren Analyse fataler Fehler
</onlyinclude>
[[Kategorie:Wikipedia:Lua/Modul/Dokumentation|JSONutil/en]]