duktape/website/api/duk_remove.yaml

name: duk_remove

proto: |
  void duk_remove(duk_context *ctx, duk_idx_t idx);

stack: |
  [ ... val(idx)! ... ] -> [ ... ... ]

summary: |
  <p>Remove value at <code>idx</code>.  Elements above <code>idx</code>
  are shifted down the stack by a step.  If <code>idx</code> is an invalid
  index, throws an error.</p>

example: |
  duk_push_int(ctx, 123);
  duk_push_int(ctx, 234);
  duk_push_int(ctx, 345);       /* -> [ 123 234 345 ] */
  duk_remove(ctx, -2);          /* -> [ 123 345 ] */

tags:
  - stack

introduced: 1.0.0
YAML conversions (using api2yaml.py) 10 years ago			`name: duk_remove`
api doc and test for duk_replace, duk_insert, duk_remove 11 years ago
YAML conversions (using api2yaml.py) 10 years ago			`proto: \|`
Avoid 'index' also in API docs 9 years ago			`void duk_remove(duk_context *ctx, duk_idx_t idx);`
api doc and test for duk_replace, duk_insert, duk_remove 11 years ago
YAML conversions (using api2yaml.py) 10 years ago			`stack: \|`
Avoid 'index' also in API docs 9 years ago			`[ ... val(idx)! ... ] -> [ ... ... ]`
api doc and test for duk_replace, duk_insert, duk_remove 11 years ago
YAML conversions (using api2yaml.py) 10 years ago			`summary: \|`
Avoid 'index' also in API docs 9 years ago			`<p>Remove value at <code>idx</code>. Elements above <code>idx</code>`
			`are shifted down the stack by a step. If <code>idx</code> is an invalid`
			`index, throws an error.</p>`
add an initial set of (more or less random) tags to api docs 11 years ago
YAML conversions (using api2yaml.py) 10 years ago			`example: \|`
			`duk_push_int(ctx, 123);`
			`duk_push_int(ctx, 234);`
			`duk_push_int(ctx, 345); /* -> [ 123 234 345 ] */`
			`duk_remove(ctx, -2); /* -> [ 123 345 ] */`
Add =introduced version to API call files 10 years ago
YAML conversions (using api2yaml.py) 10 years ago			`tags:`
			`- stack`

			`introduced: 1.0.0`