--- # Copyright 2025 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. layout: docs ---
{% include docs/js/warning.html %}

{{ page.js_module.name }}

{% include docs/js/desc.html desc=page.js_module.description %} {% if page.js_module.processed_functions.size > 0 %}

Methods

{% for child in page.js_module.processed_functions %}
{% include docs/js/function.html child=child %}
{% endfor %} {% endif %} {% if page.js_module.processed_members.size > 0 %}

Members

{% for child in page.js_module.processed_members %}
{{ page.js_module.name }}.{{ child.name }}
{% include docs/js/desc.html desc=child.description %}
{% endfor %} {% endif %} {% if page.js_module.processed_typedefs.size > 0 %}

Typedefs

{% for child in page.js_module.processed_typedefs %}
{% if child.type.name == "Object" %}
{{ child.name }}
{% include docs/js/desc.html desc=child.description %} {% if child.properties.size > 0 %}

Properties

{% for prop in child.properties %}
{{ prop.type.names | first | escape }} {{ prop.name }}
{% include docs/js/desc.html desc=prop.description %} {% endfor %}
{% endif %}
{% elsif child.type.name == "Function" %} {% include docs/js/function.html child=child %} {% endif %}
{% endfor %} {% endif %}