@defold-typescript/types 0.5.4 → 0.6.0

package/generated/profiler.d.ts

@@ -2,6 +2,10 @@
 import type { Opaque } from "../src/core-types";
 
 declare global {
+  /**
+   * Functions for getting profiling data in runtime.
+   * More detailed [profiling](https://www.defold.com/manuals/profiling/) and [debugging](http://www.defold.com/manuals/debugging/) information available in the manuals.
+   */
   namespace profiler {
     /**
      * pause on current frame
@@ -31,8 +35,8 @@ declare global {
      * logs the current frame to the console
      *
      * @example
-     * ```lua
-     * profiler.dump_frame()
+     * ```ts
+     * profiler.dump_frame();
      * ```
      */
     function dump_frame(): void;
@@ -43,9 +47,9 @@ declare global {
      *
      * @param enabled - true to enable, false to disable
      * @example
-     * ```lua
-     * -- Show the profiler UI
-     * profiler.enable(true)
+     * ```ts
+     * // Show the profiler UI
+     * profiler.enable(true);
      * ```
      */
     function enable(enabled: boolean): void;
@@ -57,9 +61,9 @@ declare global {
      *
      * @param enabled - true to enable, false to disable
      * @example
-     * ```lua
-     * -- Show the profiler UI
-     * profiler.enable_ui(true)
+     * ```ts
+     * // Show the profiler UI
+     * profiler.enable_ui(true);
      * ```
      */
     function enable_ui(enabled: boolean): void;
@@ -92,12 +96,12 @@ declare global {
      *
      * @returns used by the application
      * @example
-     * ```lua
-     * Get memory usage before and after loading a collection:
-     * print(profiler.get_memory_usage())
-     * msg.post("#collectionproxy", "load")
-     * ...
-     * print(profiler.get_memory_usage()) -- will report a higher number than the initial call
+     * ```ts
+     * // Get memory usage before and after loading a collection:
+     * print(profiler.get_memory_usage());
+     * msg.post("#collectionproxy", "load");
+     * // ...
+     * print(profiler.get_memory_usage()); // will report a higher number than the initial call
      * ```
      */
     function get_memory_usage(): number;
@@ -106,8 +110,8 @@ declare global {
      *
      * @param text - the string to send to the connected profiler
      * @example
-     * ```lua
-     * profiler.log_text("Event: " .. name)
+     * ```ts
+     * profiler.log_text(`Event: ${name}`);
      * ```
      */
     function log_text(text: string): void;
@@ -116,10 +120,10 @@ declare global {
      *
      * @returns the number of recorded frames, zero if on-screen profiler is disabled
      * @example
-     * ```lua
-     * -- Show the last recorded frame
-     * local recorded_frame_count = profiler.recorded_frame_count()
-     * profiler.view_recorded_frame(recorded_frame_count)
+     * ```ts
+     * // Show the last recorded frame
+     * const recorded_frame_count = profiler.recorded_frame_count();
+     * profiler.view_recorded_frame(recorded_frame_count);
      * ```
      */
     function recorded_frame_count(): number;
@@ -128,11 +132,11 @@ declare global {
      *
      * @param name - The name of the scope
      * @example
-     * ```lua
-     * -- Go back one frame
-     * profiler.scope_begin("test_function")
-     *   test_function()
-     * profiler.scope_end()
+     * ```ts
+     * // Go back one frame
+     * profiler.scope_begin("test_function");
+     * test_function();
+     * profiler.scope_end();
      * ```
      */
     function scope_begin(name: string): void;
@@ -152,14 +156,14 @@ declare global {
      * You can also use the `view_recorded_frame` function to display a recorded frame. Doing so stops the recording as well.
      * Every time you switch to recording mode the recording buffer is cleared.
      * @example
-     * ```lua
-     * function start_recording()
-     *      profiler.set_ui_mode(profiler.MODE_RECORD)
-     * end
+     * ```ts
+     * function start_recording() {
+     *   profiler.set_ui_mode(profiler.MODE_RECORD);
+     * }
      *
-     * function stop_recording()
-     *      profiler.set_ui_mode(profiler.MODE_PAUSE)
-     * end
+     * function stop_recording() {
+     *   profiler.set_ui_mode(profiler.MODE_PAUSE);
+     * }
      * ```
      */
     function set_ui_mode(mode: Opaque<"constant">): void;
@@ -170,9 +174,9 @@ declare global {
      * - `profiler.VIEW_MODE_FULL` The default mode which displays all the ui profiler details
      * - `profiler.VIEW_MODE_MINIMIZED` Minimized mode which only shows the top header (fps counters and ui profiler mode)
      * @example
-     * ```lua
-     * -- Minimize the profiler view
-     * profiler.set_ui_view_mode(profiler.VIEW_MODE_MINIMIZED)
+     * ```ts
+     * // Minimize the profiler view
+     * profiler.set_ui_view_mode(profiler.VIEW_MODE_MINIMIZED);
      * ```
      */
     function set_ui_view_mode(mode: Opaque<"constant">): void;
@@ -190,9 +194,9 @@ declare global {
      *
      * @param visible - true to include it in the display, false to hide it.
      * @example
-     * ```lua
-     * -- Exclude frame wait time form the profiler ui
-     * profiler.set_ui_vsync_wait_visible(false)
+     * ```ts
+     * // Exclude frame wait time from the profiler ui
+     * profiler.set_ui_vsync_wait_visible(false);
      * ```
      */
     function set_ui_vsync_wait_visible(visible: boolean): void;
@@ -204,9 +208,9 @@ declare global {
      * - `distance` The offset from the currently displayed frame (this is truncated between zero and the number of recorded frames)
      * - `frame` The frame index in the recording buffer (1 is first recorded frame)
      * @example
-     * ```lua
-     * -- Go back one frame
-     * profiler.view_recorded_frame({distance = -1})
+     * ```ts
+     * // Go back one frame
+     * profiler.view_recorded_frame({ distance: -1 });
      * ```
      */
     function view_recorded_frame(frame_index: Record<string | number, unknown>): void;

package/generated/push.d.ts

@@ -1,5 +1,8 @@
 /** @noSelfInFile */
 declare global {
+  /**
+   * Functions and constants for interacting with local, as well as Apple''s and Google''s push notification services. These API's only exist on mobile platforms. [icon:ios] [icon:android]
+   */
   namespace push {
     /**
      * Use this function to cancel a previously scheduled local push notification.
@@ -33,7 +36,7 @@ declare global {
      * @param notifications - The types of notifications to listen to. [icon:ios]
      * @param callback - Register callback function.
      */
-    function register(notifications: Record<string | number, unknown>, callback: (...args: unknown[]) => unknown): void;
+    function register(notifications: number[], callback: (...args: unknown[]) => unknown): void;
     /**
      * Local push notifications are scheduled with this function.
      * The returned `id` value is uniquely identifying the scheduled notification and can be stored for later reference.
@@ -44,7 +47,7 @@ declare global {
      * @param payload - JSON string to be passed to the registered listener function.
      * @param notification_settings - Table with notification and platform specific fields
      */
-    function schedule(time: number, title: string, alert: string, payload: string, notification_settings: Record<string | number, unknown>): LuaMultiReturn<[number, string]>;
+    function schedule(time: number, title: string, alert: string, payload: string, notification_settings: { action?: string; badge_count?: number; priority?: number }): LuaMultiReturn<[number, string]>;
     /**
      * Set the badge count for application icon. This function is only available on iOS. [icon:ios]
      *