docs: type names changed from wrapper to primitive (#31752)
This commit is contained in:
Milan Burda
GitHub
parent
246884c4fb
commit
e6b1d95a1c
115 changed files with 1685 additions and 1685 deletions
|
|
@ -1,4 +1,4 @@
|
|||
# BluetoothDevice Object
|
||||
|
||||
* `deviceName` String
|
||||
* `deviceId` String
|
||||
* `deviceName` string
|
||||
* `deviceId` string
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
# CertificatePrincipal Object
|
||||
|
||||
* `commonName` String - Common Name.
|
||||
* `organizations` String[] - Organization names.
|
||||
* `organizationUnits` String[] - Organization Unit names.
|
||||
* `locality` String - Locality.
|
||||
* `state` String - State or province.
|
||||
* `country` String - Country or region.
|
||||
* `commonName` string - Common Name.
|
||||
* `organizations` string[] - Organization names.
|
||||
* `organizationUnits` string[] - Organization Unit names.
|
||||
* `locality` string - Locality.
|
||||
* `state` string - State or province.
|
||||
* `country` string - Country or region.
|
||||
|
|
|
|||
|
|
@ -1,12 +1,12 @@
|
|||
# Certificate Object
|
||||
|
||||
* `data` String - PEM encoded data
|
||||
* `data` string - PEM encoded data
|
||||
* `issuer` [CertificatePrincipal](certificate-principal.md) - Issuer principal
|
||||
* `issuerName` String - Issuer's Common Name
|
||||
* `issuerName` string - Issuer's Common Name
|
||||
* `issuerCert` Certificate - Issuer certificate (if not self-signed)
|
||||
* `subject` [CertificatePrincipal](certificate-principal.md) - Subject principal
|
||||
* `subjectName` String - Subject's Common Name
|
||||
* `serialNumber` String - Hex value represented string
|
||||
* `validStart` Number - Start date of the certificate being valid in seconds
|
||||
* `validExpiry` Number - End date of the certificate being valid in seconds
|
||||
* `fingerprint` String - Fingerprint of the certificate
|
||||
* `subjectName` string - Subject's Common Name
|
||||
* `serialNumber` string - Hex value represented string
|
||||
* `validStart` number - Start date of the certificate being valid in seconds
|
||||
* `validExpiry` number - End date of the certificate being valid in seconds
|
||||
* `fingerprint` string - Fingerprint of the certificate
|
||||
|
|
|
|||
|
|
@ -1,15 +1,15 @@
|
|||
# Cookie Object
|
||||
|
||||
* `name` String - The name of the cookie.
|
||||
* `value` String - The value of the cookie.
|
||||
* `domain` String (optional) - The domain of the cookie; this will be normalized with a preceding dot so that it's also valid for subdomains.
|
||||
* `hostOnly` Boolean (optional) - Whether the cookie is a host-only cookie; this will only be `true` if no domain was passed.
|
||||
* `path` String (optional) - The path of the cookie.
|
||||
* `secure` Boolean (optional) - Whether the cookie is marked as secure.
|
||||
* `httpOnly` Boolean (optional) - Whether the cookie is marked as HTTP only.
|
||||
* `session` Boolean (optional) - Whether the cookie is a session cookie or a persistent
|
||||
* `name` string - The name of the cookie.
|
||||
* `value` string - The value of the cookie.
|
||||
* `domain` string (optional) - The domain of the cookie; this will be normalized with a preceding dot so that it's also valid for subdomains.
|
||||
* `hostOnly` boolean (optional) - Whether the cookie is a host-only cookie; this will only be `true` if no domain was passed.
|
||||
* `path` string (optional) - The path of the cookie.
|
||||
* `secure` boolean (optional) - Whether the cookie is marked as secure.
|
||||
* `httpOnly` boolean (optional) - Whether the cookie is marked as HTTP only.
|
||||
* `session` boolean (optional) - Whether the cookie is a session cookie or a persistent
|
||||
cookie with an expiration date.
|
||||
* `expirationDate` Double (optional) - The expiration date of the cookie as
|
||||
the number of seconds since the UNIX epoch. Not provided for session
|
||||
cookies.
|
||||
* `sameSite` String - The [Same Site](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#SameSite_cookies) policy applied to this cookie. Can be `unspecified`, `no_restriction`, `lax` or `strict`.
|
||||
* `sameSite` string - The [Same Site](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#SameSite_cookies) policy applied to this cookie. Can be `unspecified`, `no_restriction`, `lax` or `strict`.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# CPUUsage Object
|
||||
|
||||
* `percentCPUUsage` Number - Percentage of CPU used since the last call to getCPUUsage.
|
||||
* `percentCPUUsage` number - Percentage of CPU used since the last call to getCPUUsage.
|
||||
First call returns 0.
|
||||
* `idleWakeupsPerSecond` Number - The number of average idle CPU wakeups per second
|
||||
* `idleWakeupsPerSecond` number - The number of average idle CPU wakeups per second
|
||||
since the last call to getCPUUsage. First call returns 0. Will always return 0 on
|
||||
Windows.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# CrashReport Object
|
||||
|
||||
* `date` Date
|
||||
* `id` String
|
||||
* `id` string
|
||||
|
|
|
|||
|
|
@ -1,11 +1,11 @@
|
|||
# CustomScheme Object
|
||||
|
||||
* `scheme` String - Custom schemes to be registered with options.
|
||||
* `scheme` string - Custom schemes to be registered with options.
|
||||
* `privileges` Object (optional)
|
||||
* `standard` Boolean (optional) - Default false.
|
||||
* `secure` Boolean (optional) - Default false.
|
||||
* `bypassCSP` Boolean (optional) - Default false.
|
||||
* `allowServiceWorkers` Boolean (optional) - Default false.
|
||||
* `supportFetchAPI` Boolean (optional) - Default false.
|
||||
* `corsEnabled` Boolean (optional) - Default false.
|
||||
* `stream` Boolean (optional) - Default false.
|
||||
* `standard` boolean (optional) - Default false.
|
||||
* `secure` boolean (optional) - Default false.
|
||||
* `bypassCSP` boolean (optional) - Default false.
|
||||
* `allowServiceWorkers` boolean (optional) - Default false.
|
||||
* `supportFetchAPI` boolean (optional) - Default false.
|
||||
* `corsEnabled` boolean (optional) - Default false.
|
||||
* `stream` boolean (optional) - Default false.
|
||||
|
|
|
|||
|
|
@ -1,13 +1,13 @@
|
|||
# DesktopCapturerSource Object
|
||||
|
||||
* `id` String - The identifier of a window or screen that can be used as a
|
||||
* `id` string - The identifier of a window or screen that can be used as a
|
||||
`chromeMediaSourceId` constraint when calling
|
||||
[`navigator.webkitGetUserMedia`]. The format of the identifier will be
|
||||
`window:XX:YY` or `screen:ZZ:0`. XX is the windowID/handle. YY is 1 for
|
||||
the current process, and 0 for all others. ZZ is a sequential number
|
||||
that represents the screen, and it does not equal to the index in the
|
||||
source's name.
|
||||
* `name` String - A screen source will be named either `Entire Screen` or
|
||||
* `name` string - A screen source will be named either `Entire Screen` or
|
||||
`Screen <index>`, while the name of a window source will match the window
|
||||
title.
|
||||
* `thumbnail` [NativeImage](../native-image.md) - A thumbnail image. **Note:**
|
||||
|
|
@ -15,7 +15,7 @@
|
|||
`thumbnailSize` specified in the `options` passed to
|
||||
`desktopCapturer.getSources`. The actual size depends on the scale of the
|
||||
screen or window.
|
||||
* `display_id` String - A unique identifier that will correspond to the `id` of
|
||||
* `display_id` string - A unique identifier that will correspond to the `id` of
|
||||
the matching [Display](display.md) returned by the [Screen API](../screen.md).
|
||||
On some platforms, this is equivalent to the `XX` portion of the `id` field
|
||||
above and on others it will differ. It will be an empty string if not
|
||||
|
|
|
|||
|
|
@ -1,21 +1,21 @@
|
|||
# Display Object
|
||||
|
||||
* `id` Number - Unique identifier associated with the display.
|
||||
* `rotation` Number - Can be 0, 90, 180, 270, represents screen rotation in
|
||||
* `id` number - Unique identifier associated with the display.
|
||||
* `rotation` number - Can be 0, 90, 180, 270, represents screen rotation in
|
||||
clock-wise degrees.
|
||||
* `scaleFactor` Number - Output device's pixel scale factor.
|
||||
* `touchSupport` String - Can be `available`, `unavailable`, `unknown`.
|
||||
* `monochrome` Boolean - Whether or not the display is a monochrome display.
|
||||
* `accelerometerSupport` String - Can be `available`, `unavailable`, `unknown`.
|
||||
* `colorSpace` String - represent a color space (three-dimensional object which contains all realizable color combinations) for the purpose of color conversions
|
||||
* `colorDepth` Number - The number of bits per pixel.
|
||||
* `depthPerComponent` Number - The number of bits per color component.
|
||||
* `displayFrequency` Number - The display refresh rate.
|
||||
* `scaleFactor` number - Output device's pixel scale factor.
|
||||
* `touchSupport` string - Can be `available`, `unavailable`, `unknown`.
|
||||
* `monochrome` boolean - Whether or not the display is a monochrome display.
|
||||
* `accelerometerSupport` string - Can be `available`, `unavailable`, `unknown`.
|
||||
* `colorSpace` string - represent a color space (three-dimensional object which contains all realizable color combinations) for the purpose of color conversions
|
||||
* `colorDepth` number - The number of bits per pixel.
|
||||
* `depthPerComponent` number - The number of bits per color component.
|
||||
* `displayFrequency` number - The display refresh rate.
|
||||
* `bounds` [Rectangle](rectangle.md) - the bounds of the display in DIP points.
|
||||
* `size` [Size](size.md)
|
||||
* `workArea` [Rectangle](rectangle.md) - the work area of the display in DIP points.
|
||||
* `workAreaSize` [Size](size.md)
|
||||
* `internal` Boolean - `true` for an internal display and `false` for an external display
|
||||
* `internal` boolean - `true` for an internal display and `false` for an external display
|
||||
|
||||
The `Display` object represents a physical display connected to the system. A
|
||||
fake `Display` may exist on a headless system, or a `Display` may correspond to
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# ExtensionInfo Object
|
||||
|
||||
* `name` String
|
||||
* `version` String
|
||||
* `name` string
|
||||
* `version` string
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
# Extension Object
|
||||
|
||||
* `id` String
|
||||
* `id` string
|
||||
* `manifest` any - Copy of the [extension's manifest data](https://developer.chrome.com/extensions/manifest).
|
||||
* `name` String
|
||||
* `path` String - The extension's file path.
|
||||
* `version` String
|
||||
* `url` String - The extension's `chrome-extension://` URL.
|
||||
* `name` string
|
||||
* `path` string - The extension's file path.
|
||||
* `version` string
|
||||
* `url` string - The extension's `chrome-extension://` URL.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# FileFilter Object
|
||||
|
||||
* `name` String
|
||||
* `extensions` String[]
|
||||
* `name` string
|
||||
* `extensions` string[]
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# FilePathWithHeaders Object
|
||||
|
||||
* `path` String - The path to the file to send.
|
||||
* `path` string - The path to the file to send.
|
||||
* `headers` Record<string, string> (optional) - Additional headers to be sent.
|
||||
|
|
|
|||
|
|
@ -1,18 +1,18 @@
|
|||
# GPUFeatureStatus Object
|
||||
|
||||
* `2d_canvas` String - Canvas.
|
||||
* `flash_3d` String - Flash.
|
||||
* `flash_stage3d` String - Flash Stage3D.
|
||||
* `flash_stage3d_baseline` String - Flash Stage3D Baseline profile.
|
||||
* `gpu_compositing` String - Compositing.
|
||||
* `multiple_raster_threads` String - Multiple Raster Threads.
|
||||
* `native_gpu_memory_buffers` String - Native GpuMemoryBuffers.
|
||||
* `rasterization` String - Rasterization.
|
||||
* `video_decode` String - Video Decode.
|
||||
* `video_encode` String - Video Encode.
|
||||
* `vpx_decode` String - VPx Video Decode.
|
||||
* `webgl` String - WebGL.
|
||||
* `webgl2` String - WebGL2.
|
||||
* `2d_canvas` string - Canvas.
|
||||
* `flash_3d` string - Flash.
|
||||
* `flash_stage3d` string - Flash Stage3D.
|
||||
* `flash_stage3d_baseline` string - Flash Stage3D Baseline profile.
|
||||
* `gpu_compositing` string - Compositing.
|
||||
* `multiple_raster_threads` string - Multiple Raster Threads.
|
||||
* `native_gpu_memory_buffers` string - Native GpuMemoryBuffers.
|
||||
* `rasterization` string - Rasterization.
|
||||
* `video_decode` string - Video Decode.
|
||||
* `video_encode` string - Video Encode.
|
||||
* `vpx_decode` string - VPx Video Decode.
|
||||
* `webgl` string - WebGL.
|
||||
* `webgl2` string - WebGL2.
|
||||
|
||||
Possible values:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
# HIDDevice Object
|
||||
|
||||
* `deviceId` String - Unique identifier for the device.
|
||||
* `name` String - Name of the device.
|
||||
* `deviceId` string - Unique identifier for the device.
|
||||
* `name` string - Name of the device.
|
||||
* `vendorId` Integer - The USB vendor ID.
|
||||
* `productId` Integer - The USB product ID.
|
||||
* `serialNumber` String (optional) - The USB device serial number.
|
||||
* `guid` String (optional) - Unique identifier for the HID interface. A device may have multiple HID interfaces.
|
||||
* `serialNumber` string (optional) - The USB device serial number.
|
||||
* `guid` string (optional) - Unique identifier for the HID interface. A device may have multiple HID interfaces.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# InputEvent Object
|
||||
|
||||
* `modifiers` String[] (optional) - An array of modifiers of the event, can
|
||||
* `modifiers` string[] (optional) - An array of modifiers of the event, can
|
||||
be `shift`, `control`, `ctrl`, `alt`, `meta`, `command`, `cmd`, `isKeypad`,
|
||||
`isAutoRepeat`, `leftButtonDown`, `middleButtonDown`, `rightButtonDown`,
|
||||
`capsLock`, `numLock`, `left`, `right`.
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
# IOCounters Object
|
||||
|
||||
* `readOperationCount` Number - The number of I/O read operations.
|
||||
* `writeOperationCount` Number - The number of I/O write operations.
|
||||
* `otherOperationCount` Number - Then number of I/O other operations.
|
||||
* `readTransferCount` Number - The number of I/O read transfers.
|
||||
* `writeTransferCount` Number - The number of I/O write transfers.
|
||||
* `otherTransferCount` Number - Then number of I/O other transfers.
|
||||
* `readOperationCount` number - The number of I/O read operations.
|
||||
* `writeOperationCount` number - The number of I/O write operations.
|
||||
* `otherOperationCount` number - Then number of I/O other operations.
|
||||
* `readTransferCount` number - The number of I/O read transfers.
|
||||
* `writeTransferCount` number - The number of I/O write transfers.
|
||||
* `otherTransferCount` number - Then number of I/O other transfers.
|
||||
|
|
|
|||
|
|
@ -7,5 +7,5 @@
|
|||
* `senderFrame` WebFrameMain _Readonly_ - The frame that sent this message
|
||||
* `ports` MessagePortMain[] - A list of MessagePorts that were transferred with this message
|
||||
* `reply` Function - A function that will send an IPC message to the renderer frame that sent the original message that you are currently handling. You should use this method to "reply" to the sent message in order to guarantee the reply will go to the correct process and frame.
|
||||
* `channel` String
|
||||
* `channel` string
|
||||
* `...args` any[]
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# JumpListCategory Object
|
||||
|
||||
* `type` String (optional) - One of the following:
|
||||
* `type` string (optional) - One of the following:
|
||||
* `tasks` - Items in this category will be placed into the standard `Tasks`
|
||||
category. There can be only one such category, and it will always be
|
||||
displayed at the bottom of the Jump List.
|
||||
|
|
@ -10,7 +10,7 @@
|
|||
of the category and its items are set by Windows. Items may be added to
|
||||
this category indirectly using `app.addRecentDocument(path)`.
|
||||
* `custom` - Displays tasks or file links, `name` must be set by the app.
|
||||
* `name` String (optional) - Must be set if `type` is `custom`, otherwise it should be
|
||||
* `name` string (optional) - Must be set if `type` is `custom`, otherwise it should be
|
||||
omitted.
|
||||
* `items` JumpListItem[] (optional) - Array of [`JumpListItem`](jump-list-item.md) objects if `type` is `tasks` or
|
||||
`custom`, otherwise it should be omitted.
|
||||
|
|
|
|||
|
|
@ -1,29 +1,29 @@
|
|||
# JumpListItem Object
|
||||
|
||||
* `type` String (optional) - One of the following:
|
||||
* `type` string (optional) - One of the following:
|
||||
* `task` - A task will launch an app with specific arguments.
|
||||
* `separator` - Can be used to separate items in the standard `Tasks`
|
||||
category.
|
||||
* `file` - A file link will open a file using the app that created the
|
||||
Jump List, for this to work the app must be registered as a handler for
|
||||
the file type (though it doesn't have to be the default handler).
|
||||
* `path` String (optional) - Path of the file to open, should only be set if `type` is
|
||||
* `path` string (optional) - Path of the file to open, should only be set if `type` is
|
||||
`file`.
|
||||
* `program` String (optional) - Path of the program to execute, usually you should
|
||||
* `program` string (optional) - Path of the program to execute, usually you should
|
||||
specify `process.execPath` which opens the current program. Should only be
|
||||
set if `type` is `task`.
|
||||
* `args` String (optional) - The command line arguments when `program` is executed. Should
|
||||
* `args` string (optional) - The command line arguments when `program` is executed. Should
|
||||
only be set if `type` is `task`.
|
||||
* `title` String (optional) - The text to be displayed for the item in the Jump List.
|
||||
* `title` string (optional) - The text to be displayed for the item in the Jump List.
|
||||
Should only be set if `type` is `task`.
|
||||
* `description` String (optional) - Description of the task (displayed in a tooltip).
|
||||
* `description` string (optional) - Description of the task (displayed in a tooltip).
|
||||
Should only be set if `type` is `task`. Maximum length 260 characters.
|
||||
* `iconPath` String (optional) - The absolute path to an icon to be displayed in a
|
||||
* `iconPath` string (optional) - The absolute path to an icon to be displayed in a
|
||||
Jump List, which can be an arbitrary resource file that contains an icon
|
||||
(e.g. `.ico`, `.exe`, `.dll`). You can usually specify `process.execPath` to
|
||||
show the program icon.
|
||||
* `iconIndex` Number (optional) - The index of the icon in the resource file. If a
|
||||
* `iconIndex` number (optional) - The index of the icon in the resource file. If a
|
||||
resource file contains multiple icons this value can be used to specify the
|
||||
zero-based index of the icon that should be displayed for this task. If a
|
||||
resource file contains only one icon, this property should be set to zero.
|
||||
* `workingDirectory` String (optional) - The working directory. Default is empty.
|
||||
* `workingDirectory` string (optional) - The working directory. Default is empty.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# KeyboardEvent Object
|
||||
|
||||
* `ctrlKey` Boolean (optional) - whether the Control key was used in an accelerator to trigger the Event
|
||||
* `metaKey` Boolean (optional) - whether a meta key was used in an accelerator to trigger the Event
|
||||
* `shiftKey` Boolean (optional) - whether a Shift key was used in an accelerator to trigger the Event
|
||||
* `altKey` Boolean (optional) - whether an Alt key was used in an accelerator to trigger the Event
|
||||
* `triggeredByAccelerator` Boolean (optional) - whether an accelerator was used to trigger the event as opposed to another user gesture like mouse click
|
||||
* `ctrlKey` boolean (optional) - whether the Control key was used in an accelerator to trigger the Event
|
||||
* `metaKey` boolean (optional) - whether a meta key was used in an accelerator to trigger the Event
|
||||
* `shiftKey` boolean (optional) - whether a Shift key was used in an accelerator to trigger the Event
|
||||
* `altKey` boolean (optional) - whether an Alt key was used in an accelerator to trigger the Event
|
||||
* `triggeredByAccelerator` boolean (optional) - whether an accelerator was used to trigger the event as opposed to another user gesture like mouse click
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# KeyboardInputEvent Object extends `InputEvent`
|
||||
|
||||
* `type` String - The type of the event, can be `keyDown`, `keyUp` or `char`.
|
||||
* `keyCode` String - The character that will be sent
|
||||
* `type` string - The type of the event, can be `keyDown`, `keyUp` or `char`.
|
||||
* `keyCode` string - The character that will be sent
|
||||
as the keyboard event. Should only use the valid key codes in
|
||||
[Accelerator](../accelerator.md).
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
# MemoryUsageDetails Object
|
||||
|
||||
* `count` Number
|
||||
* `size` Number
|
||||
* `liveSize` Number
|
||||
* `count` number
|
||||
* `size` number
|
||||
* `liveSize` number
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
# MimeTypedBuffer Object
|
||||
|
||||
* `mimeType` String (optional) - MIME type of the buffer.
|
||||
* `charset` String (optional) - Charset of the buffer.
|
||||
* `mimeType` string (optional) - MIME type of the buffer.
|
||||
* `charset` string (optional) - Charset of the buffer.
|
||||
* `data` Buffer - The actual Buffer content.
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
# MouseInputEvent Object extends `InputEvent`
|
||||
|
||||
* `type` String - The type of the event, can be `mouseDown`,
|
||||
* `type` string - The type of the event, can be `mouseDown`,
|
||||
`mouseUp`, `mouseEnter`, `mouseLeave`, `contextMenu`, `mouseWheel` or `mouseMove`.
|
||||
* `x` Integer
|
||||
* `y` Integer
|
||||
* `button` String (optional) - The button pressed, can be `left`, `middle`, `right`.
|
||||
* `button` string (optional) - The button pressed, can be `left`, `middle`, `right`.
|
||||
* `globalX` Integer (optional)
|
||||
* `globalY` Integer (optional)
|
||||
* `movementX` Integer (optional)
|
||||
|
|
|
|||
|
|
@ -1,11 +1,11 @@
|
|||
# MouseWheelInputEvent Object extends `MouseInputEvent`
|
||||
|
||||
* `type` String - The type of the event, can be `mouseWheel`.
|
||||
* `type` string - The type of the event, can be `mouseWheel`.
|
||||
* `deltaX` Integer (optional)
|
||||
* `deltaY` Integer (optional)
|
||||
* `wheelTicksX` Integer (optional)
|
||||
* `wheelTicksY` Integer (optional)
|
||||
* `accelerationRatioX` Integer (optional)
|
||||
* `accelerationRatioY` Integer (optional)
|
||||
* `hasPreciseScrollingDeltas` Boolean (optional)
|
||||
* `canScroll` Boolean (optional)
|
||||
* `hasPreciseScrollingDeltas` boolean (optional)
|
||||
* `canScroll` boolean (optional)
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# NotificationAction Object
|
||||
|
||||
* `type` String - The type of action, can be `button`.
|
||||
* `text` String (optional) - The label for the given action.
|
||||
* `type` string - The type of action, can be `button`.
|
||||
* `text` string (optional) - The label for the given action.
|
||||
|
||||
## Platform / Action Support
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# NotificationResponse Object
|
||||
|
||||
* `actionIdentifier` String - The identifier string of the action that the user selected.
|
||||
* `date` Number - The delivery date of the notification.
|
||||
* `identifier` String - The unique identifier for this notification request.
|
||||
* `userInfo` Record<String, any> - A dictionary of custom information associated with the notification.
|
||||
* `userText` String (optional) - The text entered or chosen by the user.
|
||||
* `actionIdentifier` string - The identifier string of the action that the user selected.
|
||||
* `date` number - The delivery date of the notification.
|
||||
* `identifier` string - The unique identifier for this notification request.
|
||||
* `userInfo` Record<string, any> - A dictionary of custom information associated with the notification.
|
||||
* `userText` string (optional) - The text entered or chosen by the user.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# Point Object
|
||||
|
||||
* `x` Number
|
||||
* `y` Number
|
||||
* `x` number
|
||||
* `y` number
|
||||
|
||||
**Note:** Both `x` and `y` must be whole integers, when providing a point object
|
||||
as input to an Electron API we will automatically round your `x` and `y` values
|
||||
|
|
|
|||
|
|
@ -2,10 +2,10 @@
|
|||
|
||||
* `data` ([UploadRawData](upload-raw-data.md) | [UploadFile](upload-file.md))[] - The post data to be sent to the
|
||||
new window.
|
||||
* `contentType` String - The `content-type` header used for the data. One of
|
||||
* `contentType` string - The `content-type` header used for the data. One of
|
||||
`application/x-www-form-urlencoded` or `multipart/form-data`. Corresponds to
|
||||
the `enctype` attribute of the submitted HTML form.
|
||||
* `boundary` String (optional) - The boundary used to separate multiple parts of
|
||||
* `boundary` string (optional) - The boundary used to separate multiple parts of
|
||||
the message. Only valid when `contentType` is `multipart/form-data`.
|
||||
|
||||
Note that keys starting with `--` are not currently supported. For example, this will errantly submit as `multipart/form-data` when `nativeWindowOpen` is set to `false` in webPreferences:
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
# PrinterInfo Object
|
||||
|
||||
* `name` String - the name of the printer as understood by the OS.
|
||||
* `displayName` String - the name of the printer as shown in Print Preview.
|
||||
* `description` String - a longer description of the printer's type.
|
||||
* `status` Number - the current status of the printer.
|
||||
* `isDefault` Boolean - whether or not a given printer is set as the default printer on the OS.
|
||||
* `name` string - the name of the printer as understood by the OS.
|
||||
* `displayName` string - the name of the printer as shown in Print Preview.
|
||||
* `description` string - a longer description of the printer's type.
|
||||
* `status` number - the current status of the printer.
|
||||
* `isDefault` boolean - whether or not a given printer is set as the default printer on the OS.
|
||||
* `options` Object - an object containing a variable number of platform-specific printer information.
|
||||
|
||||
The number represented by `status` means different things on different platforms: on Windows its potential values can be found [here](https://docs.microsoft.com/en-us/windows/win32/printdocs/printer-info-2), and on Linux and macOS they can be found [here](https://www.cups.org/doc/cupspm.html).
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# ProcessMetric Object
|
||||
|
||||
* `pid` Integer - Process id of the process.
|
||||
* `type` String - Process type. One of the following values:
|
||||
* `type` string - Process type. One of the following values:
|
||||
* `Browser`
|
||||
* `Tab`
|
||||
* `Utility`
|
||||
|
|
@ -11,17 +11,17 @@
|
|||
* `Pepper Plugin`
|
||||
* `Pepper Plugin Broker`
|
||||
* `Unknown`
|
||||
* `serviceName` String (optional) - The non-localized name of the process.
|
||||
* `name` String (optional) - The name of the process.
|
||||
* `serviceName` string (optional) - The non-localized name of the process.
|
||||
* `name` string (optional) - The name of the process.
|
||||
Examples for utility: `Audio Service`, `Content Decryption Module Service`, `Network Service`, `Video Capture`, etc.
|
||||
* `cpu` [CPUUsage](cpu-usage.md) - CPU usage of the process.
|
||||
* `creationTime` Number - Creation time for this process.
|
||||
* `creationTime` number - Creation time for this process.
|
||||
The time is represented as number of milliseconds since epoch.
|
||||
Since the `pid` can be reused after a process dies,
|
||||
it is useful to use both the `pid` and the `creationTime` to uniquely identify a process.
|
||||
* `memory` [MemoryInfo](memory-info.md) - Memory information for the process.
|
||||
* `sandboxed` Boolean (optional) _macOS_ _Windows_ - Whether the process is sandboxed on OS level.
|
||||
* `integrityLevel` String (optional) _Windows_ - One of the following values:
|
||||
* `sandboxed` boolean (optional) _macOS_ _Windows_ - Whether the process is sandboxed on OS level.
|
||||
* `integrityLevel` string (optional) _Windows_ - One of the following values:
|
||||
* `untrusted`
|
||||
* `low`
|
||||
* `medium`
|
||||
|
|
|
|||
|
|
@ -1,11 +1,11 @@
|
|||
# Product Object
|
||||
|
||||
* `productIdentifier` String - The string that identifies the product to the Apple App Store.
|
||||
* `localizedDescription` String - A description of the product.
|
||||
* `localizedTitle` String - The name of the product.
|
||||
* `contentVersion` String - A string that identifies the version of the content.
|
||||
* `contentLengths` Number[] - The total size of the content, in bytes.
|
||||
* `price` Number - The cost of the product in the local currency.
|
||||
* `formattedPrice` String - The locale formatted price of the product.
|
||||
* `currencyCode` String - 3 character code presenting a product's currency based on the ISO 4217 standard.
|
||||
* `isDownloadable` Boolean - A Boolean value that indicates whether the App Store has downloadable content for this product. `true` if at least one file has been associated with the product.
|
||||
* `productIdentifier` string - The string that identifies the product to the Apple App Store.
|
||||
* `localizedDescription` string - A description of the product.
|
||||
* `localizedTitle` string - The name of the product.
|
||||
* `contentVersion` string - A string that identifies the version of the content.
|
||||
* `contentLengths` number[] - The total size of the content, in bytes.
|
||||
* `price` number - The cost of the product in the local currency.
|
||||
* `formattedPrice` string - The locale formatted price of the product.
|
||||
* `currencyCode` string - 3 character code presenting a product's currency based on the ISO 4217 standard.
|
||||
* `isDownloadable` boolean - A boolean value that indicates whether the App Store has downloadable content for this product. `true` if at least one file has been associated with the product.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# ProtocolRequest Object
|
||||
|
||||
* `url` String
|
||||
* `referrer` String
|
||||
* `method` String
|
||||
* `url` string
|
||||
* `referrer` string
|
||||
* `method` string
|
||||
* `uploadData` [UploadData[]](upload-data.md) (optional)
|
||||
* `headers` Record<String, String>
|
||||
* `headers` Record<string, string>
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# ProtocolResponseUploadData Object
|
||||
|
||||
* `contentType` String - MIME type of the content.
|
||||
* `data` String | Buffer - Content to be sent.
|
||||
* `contentType` string - MIME type of the content.
|
||||
* `data` string | Buffer - Content to be sent.
|
||||
|
|
|
|||
|
|
@ -3,27 +3,27 @@
|
|||
* `error` Integer (optional) - When assigned, the `request` will fail with the
|
||||
`error` number . For the available error numbers you can use, please see the
|
||||
[net error list][net-error].
|
||||
* `statusCode` Number (optional) - The HTTP response code, default is 200.
|
||||
* `charset` String (optional) - The charset of response body, default is
|
||||
* `statusCode` number (optional) - The HTTP response code, default is 200.
|
||||
* `charset` string (optional) - The charset of response body, default is
|
||||
`"utf-8"`.
|
||||
* `mimeType` String (optional) - The MIME type of response body, default is
|
||||
* `mimeType` string (optional) - The MIME type of response body, default is
|
||||
`"text/html"`. Setting `mimeType` would implicitly set the `content-type`
|
||||
header in response, but if `content-type` is already set in `headers`, the
|
||||
`mimeType` would be ignored.
|
||||
* `headers` Record<string, string | string[]> (optional) - An object containing the response headers. The
|
||||
keys must be String, and values must be either String or Array of String.
|
||||
* `data` (Buffer | String | ReadableStream) (optional) - The response body. When
|
||||
keys must be string, and values must be either string or Array of string.
|
||||
* `data` (Buffer | string | ReadableStream) (optional) - The response body. When
|
||||
returning stream as response, this is a Node.js readable stream representing
|
||||
the response body. When returning `Buffer` as response, this is a `Buffer`.
|
||||
When returning `String` as response, this is a `String`. This is ignored for
|
||||
When returning `string` as response, this is a `string`. This is ignored for
|
||||
other types of responses.
|
||||
* `path` String (optional) - Path to the file which would be sent as response
|
||||
* `path` string (optional) - Path to the file which would be sent as response
|
||||
body. This is only used for file responses.
|
||||
* `url` String (optional) - Download the `url` and pipe the result as response
|
||||
* `url` string (optional) - Download the `url` and pipe the result as response
|
||||
body. This is only used for URL responses.
|
||||
* `referrer` String (optional) - The `referrer` URL. This is only used for file
|
||||
* `referrer` string (optional) - The `referrer` URL. This is only used for file
|
||||
and URL responses.
|
||||
* `method` String (optional) - The HTTP `method`. This is only used for file
|
||||
* `method` string (optional) - The HTTP `method`. This is only used for file
|
||||
and URL responses.
|
||||
* `session` Session (optional) - The session used for requesting URL, by default
|
||||
the HTTP request will reuse the current session. Setting `session` to `null`
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Rectangle Object
|
||||
|
||||
* `x` Number - The x coordinate of the origin of the rectangle (must be an integer).
|
||||
* `y` Number - The y coordinate of the origin of the rectangle (must be an integer).
|
||||
* `width` Number - The width of the rectangle (must be an integer).
|
||||
* `height` Number - The height of the rectangle (must be an integer).
|
||||
* `x` number - The x coordinate of the origin of the rectangle (must be an integer).
|
||||
* `y` number - The y coordinate of the origin of the rectangle (must be an integer).
|
||||
* `width` number - The width of the rectangle (must be an integer).
|
||||
* `height` number - The height of the rectangle (must be an integer).
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# Referrer Object
|
||||
|
||||
* `url` String - HTTP Referrer URL.
|
||||
* `policy` String - Can be `default`, `unsafe-url`,
|
||||
* `url` string - HTTP Referrer URL.
|
||||
* `policy` string - Can be `default`, `unsafe-url`,
|
||||
`no-referrer-when-downgrade`, `no-referrer`, `origin`,
|
||||
`strict-origin-when-cross-origin`, `same-origin` or `strict-origin`.
|
||||
See the [Referrer-Policy spec][1] for more details on the
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# ScrubberItem Object
|
||||
|
||||
* `label` String (optional) - The text to appear in this item.
|
||||
* `label` string (optional) - The text to appear in this item.
|
||||
* `icon` NativeImage (optional) - The image to appear in this item.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
# SegmentedControlSegment Object
|
||||
|
||||
* `label` String (optional) - The text to appear in this segment.
|
||||
* `label` string (optional) - The text to appear in this segment.
|
||||
* `icon` NativeImage (optional) - The image to appear in this segment.
|
||||
* `enabled` Boolean (optional) - Whether this segment is selectable. Default: true.
|
||||
* `enabled` boolean (optional) - Whether this segment is selectable. Default: true.
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
# SerialPort Object
|
||||
|
||||
* `portId` String - Unique identifier for the port.
|
||||
* `portName` String - Name of the port.
|
||||
* `displayName` String - A string suitable for display to the user for describing this device.
|
||||
* `vendorId` String - Optional USB vendor ID.
|
||||
* `productId` String - Optional USB product ID.
|
||||
* `serialNumber` String - The USB device serial number.
|
||||
* `usbDriverName` String (optional) - Represents a single serial port on macOS can be enumerated by multiple drivers.
|
||||
* `deviceInstanceId` String (optional) - A stable identifier on Windows that can be used for device permissions.
|
||||
* `portId` string - Unique identifier for the port.
|
||||
* `portName` string - Name of the port.
|
||||
* `displayName` string - A string suitable for display to the user for describing this device.
|
||||
* `vendorId` string - Optional USB vendor ID.
|
||||
* `productId` string - Optional USB product ID.
|
||||
* `serialNumber` string - The USB device serial number.
|
||||
* `usbDriverName` string (optional) - Represents a single serial port on macOS can be enumerated by multiple drivers.
|
||||
* `deviceInstanceId` string (optional) - A stable identifier on Windows that can be used for device permissions.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
# ServiceWorkerInfo Object
|
||||
|
||||
* `scriptUrl` String - The full URL to the script that this service worker runs
|
||||
* `scope` String - The base URL that this service worker is active for.
|
||||
* `renderProcessId` Number - The virtual ID of the process that this service worker is running in. This is not an OS level PID. This aligns with the ID set used for `webContents.getProcessId()`.
|
||||
* `scriptUrl` string - The full URL to the script that this service worker runs
|
||||
* `scope` string - The base URL that this service worker is active for.
|
||||
* `renderProcessId` number - The virtual ID of the process that this service worker is running in. This is not an OS level PID. This aligns with the ID set used for `webContents.getProcessId()`.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# SharedWorkerInfo Object
|
||||
|
||||
* `id` String - The unique id of the shared worker.
|
||||
* `url` String - The url of the shared worker.
|
||||
* `id` string - The unique id of the shared worker.
|
||||
* `url` string - The url of the shared worker.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
# SharingItem Object
|
||||
|
||||
* `texts` String[] (optional) - An array of text to share.
|
||||
* `filePaths` String[] (optional) - An array of files to share.
|
||||
* `urls` String[] (optional) - An array of URLs to share.
|
||||
* `texts` string[] (optional) - An array of text to share.
|
||||
* `filePaths` string[] (optional) - An array of files to share.
|
||||
* `urls` string[] (optional) - An array of URLs to share.
|
||||
|
|
|
|||
|
|
@ -1,17 +1,17 @@
|
|||
# ShortcutDetails Object
|
||||
|
||||
* `target` String - The target to launch from this shortcut.
|
||||
* `cwd` String (optional) - The working directory. Default is empty.
|
||||
* `args` String (optional) - The arguments to be applied to `target` when
|
||||
* `target` string - The target to launch from this shortcut.
|
||||
* `cwd` string (optional) - The working directory. Default is empty.
|
||||
* `args` string (optional) - The arguments to be applied to `target` when
|
||||
launching from this shortcut. Default is empty.
|
||||
* `description` String (optional) - The description of the shortcut. Default
|
||||
* `description` string (optional) - The description of the shortcut. Default
|
||||
is empty.
|
||||
* `icon` String (optional) - The path to the icon, can be a DLL or EXE. `icon`
|
||||
* `icon` string (optional) - The path to the icon, can be a DLL or EXE. `icon`
|
||||
and `iconIndex` have to be set together. Default is empty, which uses the
|
||||
target's icon.
|
||||
* `iconIndex` Number (optional) - The resource ID of icon when `icon` is a
|
||||
* `iconIndex` number (optional) - The resource ID of icon when `icon` is a
|
||||
DLL or EXE. Default is 0.
|
||||
* `appUserModelId` String (optional) - The Application User Model ID. Default
|
||||
* `appUserModelId` string (optional) - The Application User Model ID. Default
|
||||
is empty.
|
||||
* `toastActivatorClsid` String (optional) - The Application Toast Activator CLSID. Needed
|
||||
* `toastActivatorClsid` string (optional) - The Application Toast Activator CLSID. Needed
|
||||
for participating in Action Center.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Size Object
|
||||
|
||||
* `width` Number
|
||||
* `height` Number
|
||||
* `width` number
|
||||
* `height` number
|
||||
|
|
|
|||
|
|
@ -1,15 +1,15 @@
|
|||
# Task Object
|
||||
|
||||
* `program` String - Path of the program to execute, usually you should
|
||||
* `program` string - Path of the program to execute, usually you should
|
||||
specify `process.execPath` which opens the current program.
|
||||
* `arguments` String - The command line arguments when `program` is
|
||||
* `arguments` string - The command line arguments when `program` is
|
||||
executed.
|
||||
* `title` String - The string to be displayed in a JumpList.
|
||||
* `description` String - Description of this task.
|
||||
* `iconPath` String - The absolute path to an icon to be displayed in a
|
||||
* `title` string - The string to be displayed in a JumpList.
|
||||
* `description` string - Description of this task.
|
||||
* `iconPath` string - The absolute path to an icon to be displayed in a
|
||||
JumpList, which can be an arbitrary resource file that contains an icon. You
|
||||
can usually specify `process.execPath` to show the icon of the program.
|
||||
* `iconIndex` Number - The icon index in the icon file. If an icon file
|
||||
* `iconIndex` number - The icon index in the icon file. If an icon file
|
||||
consists of two or more icons, set this value to identify the icon. If an
|
||||
icon file consists of one icon, this value is 0.
|
||||
* `workingDirectory` String (optional) - The working directory. Default is empty.
|
||||
* `workingDirectory` string (optional) - The working directory. Default is empty.
|
||||
|
|
|
|||
|
|
@ -3,11 +3,11 @@
|
|||
* `icon` [NativeImage](../native-image.md) - The icon showing in thumbnail
|
||||
toolbar.
|
||||
* `click` Function
|
||||
* `tooltip` String (optional) - The text of the button's tooltip.
|
||||
* `flags` String[] (optional) - Control specific states and behaviors of the
|
||||
* `tooltip` string (optional) - The text of the button's tooltip.
|
||||
* `flags` string[] (optional) - Control specific states and behaviors of the
|
||||
button. By default, it is `['enabled']`.
|
||||
|
||||
The `flags` is an array that can include following `String`s:
|
||||
The `flags` is an array that can include following `string`s:
|
||||
|
||||
* `enabled` - The button is active and available to the user.
|
||||
* `disabled` - The button is disabled. It is present, but has a visual state
|
||||
|
|
|
|||
|
|
@ -1,11 +1,11 @@
|
|||
# TraceCategoriesAndOptions Object
|
||||
|
||||
* `categoryFilter` String - A filter to control what category groups
|
||||
* `categoryFilter` string - A filter to control what category groups
|
||||
should be traced. A filter can have an optional '-' prefix to exclude
|
||||
category groups that contain a matching category. Having both included
|
||||
and excluded category patterns in the same list is not supported. Examples:
|
||||
`test_MyTest*`, `test_MyTest*,test_OtherStuff`, `-excluded_category1,-excluded_category2`.
|
||||
* `traceOptions` String - Controls what kind of tracing is enabled,
|
||||
* `traceOptions` string - Controls what kind of tracing is enabled,
|
||||
it is a comma-delimited sequence of the following strings:
|
||||
`record-until-full`, `record-continuously`, `trace-to-console`, `enable-sampling`, `enable-systrace`,
|
||||
e.g. `'record-until-full,enable-sampling'`.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# TraceConfig Object
|
||||
|
||||
* `recording_mode` String (optional) - Can be `record-until-full`, `record-continuously`, `record-as-much-as-possible` or `trace-to-console`. Defaults to `record-until-full`.
|
||||
* `recording_mode` string (optional) - Can be `record-until-full`, `record-continuously`, `record-as-much-as-possible` or `trace-to-console`. Defaults to `record-until-full`.
|
||||
* `trace_buffer_size_in_kb` number (optional) - maximum size of the trace
|
||||
recording buffer in kilobytes. Defaults to 100MB.
|
||||
* `trace_buffer_size_in_events` number (optional) - maximum size of the trace
|
||||
|
|
@ -9,17 +9,17 @@
|
|||
according to a specific list of events that have been manually vetted to not
|
||||
include any PII. See [the implementation in
|
||||
Chromium][trace_event_args_whitelist.cc] for specifics.
|
||||
* `included_categories` String[] (optional) - a list of tracing categories to
|
||||
* `included_categories` string[] (optional) - a list of tracing categories to
|
||||
include. Can include glob-like patterns using `*` at the end of the category
|
||||
name. See [tracing categories][] for the list of categories.
|
||||
* `excluded_categories` String[] (optional) - a list of tracing categories to
|
||||
* `excluded_categories` string[] (optional) - a list of tracing categories to
|
||||
exclude. Can include glob-like patterns using `*` at the end of the category
|
||||
name. See [tracing categories][] for the list of categories.
|
||||
* `included_process_ids` number[] (optional) - a list of process IDs to
|
||||
include in the trace. If not specified, trace all processes.
|
||||
* `histogram_names` String[] (optional) - a list of [histogram][] names to report
|
||||
* `histogram_names` string[] (optional) - a list of [histogram][] names to report
|
||||
with the trace.
|
||||
* `memory_dump_config` Record<String, any> (optional) - if the
|
||||
* `memory_dump_config` Record<string, any> (optional) - if the
|
||||
`disabled-by-default-memory-infra` category is enabled, this contains
|
||||
optional additional configuration for data collection. See the [Chromium
|
||||
memory-infra docs][memory-infra docs] for more information.
|
||||
|
|
|
|||
|
|
@ -1,11 +1,11 @@
|
|||
# Transaction Object
|
||||
|
||||
* `transactionIdentifier` String - A string that uniquely identifies a successful payment transaction.
|
||||
* `transactionDate` String - The date the transaction was added to the App Store’s payment queue.
|
||||
* `originalTransactionIdentifier` String - The identifier of the restored transaction by the App Store.
|
||||
* `transactionState` String - The transaction state, can be `purchasing`, `purchased`, `failed`, `restored` or `deferred`.
|
||||
* `transactionIdentifier` string - A string that uniquely identifies a successful payment transaction.
|
||||
* `transactionDate` string - The date the transaction was added to the App Store’s payment queue.
|
||||
* `originalTransactionIdentifier` string - The identifier of the restored transaction by the App Store.
|
||||
* `transactionState` string - The transaction state, can be `purchasing`, `purchased`, `failed`, `restored` or `deferred`.
|
||||
* `errorCode` Integer - The error code if an error occurred while processing the transaction.
|
||||
* `errorMessage` String - The error message if an error occurred while processing the transaction.
|
||||
* `errorMessage` string - The error message if an error occurred while processing the transaction.
|
||||
* `payment` Object
|
||||
* `productIdentifier` String - The identifier of the purchased product.
|
||||
* `productIdentifier` string - The identifier of the purchased product.
|
||||
* `quantity` Integer - The quantity purchased.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# UploadData Object
|
||||
|
||||
* `bytes` Buffer - Content being sent.
|
||||
* `file` String (optional) - Path of file being uploaded.
|
||||
* `blobUUID` String (optional) - UUID of blob data. Use [ses.getBlobData](../session.md#sesgetblobdataidentifier) method
|
||||
* `file` string (optional) - Path of file being uploaded.
|
||||
* `blobUUID` string (optional) - UUID of blob data. Use [ses.getBlobData](../session.md#sesgetblobdataidentifier) method
|
||||
to retrieve the data.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# UploadFile Object
|
||||
|
||||
* `type` 'file' - `file`.
|
||||
* `filePath` String - Path of file to be uploaded.
|
||||
* `filePath` string - Path of file to be uploaded.
|
||||
* `offset` Integer - Defaults to `0`.
|
||||
* `length` Integer - Number of bytes to read from `offset`.
|
||||
Defaults to `0`.
|
||||
|
|
|
|||
|
|
@ -1,11 +1,11 @@
|
|||
# UserDefaultTypes Object
|
||||
|
||||
* `string` String
|
||||
* `boolean` Boolean
|
||||
* `integer` Number
|
||||
* `float` Number
|
||||
* `double` Number
|
||||
* `url` String
|
||||
* `string` string
|
||||
* `boolean` boolean
|
||||
* `integer` number
|
||||
* `float` number
|
||||
* `double` number
|
||||
* `url` string
|
||||
* `array` Array\<unknown>
|
||||
* `dictionary` Record\<string, unknown>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
# WebRequestFilter Object
|
||||
|
||||
* `urls` String[] - Array of URL patterns that will be used to filter out the requests that do not match the URL patterns.
|
||||
* `urls` string[] - Array of URL patterns that will be used to filter out the requests that do not match the URL patterns.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
# WebSource Object
|
||||
|
||||
* `code` String
|
||||
* `url` String (optional)
|
||||
* `code` string
|
||||
* `url` string (optional)
|
||||
* `startLine` Integer (optional) - Default is 1.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue