mirror of https://github.com/svaarala/duktape.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
32 lines
1.1 KiB
32 lines
1.1 KiB
=proto
|
|
void duk_to_defaultvalue(duk_context *ctx, int index, int hint);
|
|
|
|
=stack
|
|
[ ... val! ... ] -> [ ... DefaultValue(val)! ... ]
|
|
|
|
=summary
|
|
<p>Replace the object at <code>index</code> with an Ecmascript
|
|
<a href="http://www.ecma-international.org/ecma-262/5.1/#sec-8.12.8">[[DefaultValue]]</a>
|
|
coerced value. The <code>hint</code> argument indicates preference for a string
|
|
(<code>DUK_HINT_STRING</code>), a number (<code>DUK_HINT_NUMBER</code>), or neither
|
|
(<code>DUK_HINT_NONE</code>). <code>DUK_HINT_NONE</code> causes a preference to a number, unless
|
|
the input value is a <code>Date</code> instance, in which case a string is preferred
|
|
(the exact coercion behavior is described in the Ecmascript specification).
|
|
If the value is not an object or <code>index</code> is invalid, throws an error.</p>
|
|
|
|
<p>Custom type coercion: both buffer and pointer are non-object values, so they
|
|
cause an error to be thrown.</p>
|
|
|
|
<div class="note">
|
|
<code>[[DefaultValue]]</code> is a rather technical coercion, not usually needed by
|
|
calling code.
|
|
</div>
|
|
|
|
=example
|
|
duk_to_defaultvalue(ctx, -3, DUK_HINT_NUMBER);
|
|
|
|
=tags
|
|
stack
|
|
|
|
=fixme
|
|
Remove from exposed API? 'coerce' tag?
|
|
|