Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions apidoc/NodeJS/assert.yml
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ methods:
Besides the async nature to await the completion behaves identically to `assert.doesNotThrow()`.
parameters:
- name: asyncFn
type: [ Function, Promise<Object> ]
type: [ Function, Promise ]
summary: function to invoke
- name: error
type: [ RegExp, Function ]
Expand Down Expand Up @@ -259,7 +259,7 @@ methods:
If specified, `message` will be the message provided by the `AssertionError` if the `asyncFn` fails to reject.
parameters:
- name: asyncFn
type: [ Function, Promise<any> ]
type: [ Function, Promise ]
summary: function to invoke
- name: error
type: [ RegExp, Function, Object, Error ]
Expand Down
121 changes: 92 additions & 29 deletions apidoc/NodeJS/fs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ methods:
default: fs.constants.F_OK
optional: true
- name: callback
type: Function<Error>
type: Callback<Error>
summary: typical async callback function

- name: accessSync
Expand Down Expand Up @@ -133,7 +133,7 @@ methods:
summary: options
optional: true
- name: callback
type: Function<Error>
type: Callback<Error>
summary: typical async callback function

- name: appendFileSync
Expand Down Expand Up @@ -164,7 +164,7 @@ methods:
type: [ String, Number ]
summary: new mode/permissions
- name: callback
type: Function<Error>
type: Callback<Error>
summary: typical async callback function

- name: chmodSync
Expand Down Expand Up @@ -196,7 +196,7 @@ methods:
type: Number
summary: new group
- name: callback
type: Function<Error>
type: Callback<Error>
summary: typical async callback function

- name: chownSync
Expand Down Expand Up @@ -225,7 +225,7 @@ methods:
type: Number
summary: file descriptor
- name: callback
type: Function<Error>
type: Callback<Error>
summary: typical async callback function

- name: closeSync
Expand Down Expand Up @@ -260,7 +260,7 @@ methods:
optional: true
default: 0
- name: callback
type: Function<Error>
type: Callback<Error>
summary: typical async callback function

- name: copyFileSync
Expand Down Expand Up @@ -297,7 +297,7 @@ methods:
summary: file path

- name: callback
type: Function<Boolean>
type: Callback<Boolean>
summary: atypical async callback function that received the result as a single boolean arguments

- name: existsSync(path)
Expand All @@ -322,7 +322,7 @@ methods:
type: [ String, Number ]
summary: new mode/permissions
- name: callback
type: Function<Error>
type: Callback<Error>
summary: typical async callback function

- name: fchmodSync
Expand Down Expand Up @@ -354,7 +354,7 @@ methods:
type: Number
summary: new group
- name: callback
type: Function<Error>
type: Callback<Error>
summary: typical async callback function

- name: fchownSync
Expand Down Expand Up @@ -383,7 +383,7 @@ methods:
type: Number
summary: file descriptor
- name: callback
type: Function<Error>
type: Callback<Error>
summary: typical async callback function

- name: fdatasyncSync
Expand All @@ -410,7 +410,7 @@ methods:
optional: true
summary: options
- name: callback
type: Function<Error, fs.Stats>
type: Callback<fs.StatsResponse>
summary: typical async callback function

- name: fstatSync
Expand All @@ -437,7 +437,7 @@ methods:
optional: true
summary: options
- name: callback
type: Function<Error, fs.Stats>
type: Callback<fs.StatsResponse>
summary: typical async callback function

- name: lstatSync
Expand Down Expand Up @@ -470,7 +470,7 @@ methods:
optional: true
summary: options
- name: callback
type: Function<Error, String>
type: Callback<fs.StringResponse>
summary: typical async callback function. The second argument is an optional path `string`.

- name: mkdirSync
Expand Down Expand Up @@ -509,7 +509,7 @@ methods:
optional: true
summary: encoding if `string`
- name: callback
type: Function<Error, String>
type: Callback<fs.StringResponse>
summary: typical async callback function. The second argument is the generated path `string`.

- name: mkdtempSync
Expand Down Expand Up @@ -551,7 +551,7 @@ methods:
optional: true
default: 0o666
- name: callback
type: Function<Error, Number>
type: Callback<fs.NumberResponse>
summary: typical async callback function, the second argument is an integer representing a file descriptor

# Not implemented:
Expand Down Expand Up @@ -611,7 +611,7 @@ methods:
type: Number
summary: where to begin reading from in the file. *Unused/unsupported in Titanium.*
- name: callback
type: Function<Error, Number, buffer.Buffer>
type: Callback<fs.ReadResponse>
summary: async callback function

- name: readdir
Expand All @@ -630,7 +630,7 @@ methods:
summary: options
optional: true
- name: callback
type: Function<Error, Array<String>>
type: Callback<fs.ArrayResponse>
summary: |
Typical async callback function. The second argument is an array of results which may be `String`s, <buffer.Buffer>s, or <fs.Dirent>s

Expand Down Expand Up @@ -665,7 +665,7 @@ methods:
summary: encoding `string`, or an options object
optional: true
- name: callback
type: Function<Error, String>
type: Callback<fs.StringResponse>
summary: typical async callback function, the second argument is either a `string` or a <buffer.Buffer>

- name: readFileSync
Expand Down Expand Up @@ -726,7 +726,7 @@ methods:
# TODO: define a type for fs.realpath.options
optional: true
- name: callback
type: Function<Error, String>
type: Callback<fs.StringResponse>
summary: typical async callback function

- name: realpath.native
Expand All @@ -748,7 +748,7 @@ methods:
# TODO: define a type for fs.realpath.options
optional: true
- name: callback
type: Function<Error, String>
type: Callback<fs.StringResponse>
summary: typical async callback function

- name: realpathSync
Expand Down Expand Up @@ -798,7 +798,7 @@ methods:
type: [ String, buffer.Buffer ]
summary: destination file path
- name: callback
type: Function<Error>
type: Callback<Error>
summary: typical async callback function

- name: renameSync
Expand All @@ -822,7 +822,7 @@ methods:
summary: options
optional: true
- name: callback
type: Function<Error>
type: Callback<Error>
summary: typical async callback function

# Not implemented:
Expand Down Expand Up @@ -880,7 +880,7 @@ methods:
optional: true
summary: fs.stat.options
- name: callback
type: Function<Error, fs.Stats>
type: Callback<fs.StatsResponse>
summary: typical async callback function

- name: statSync
Expand Down Expand Up @@ -909,7 +909,7 @@ methods:
type: [ String, buffer.Buffer ]
summary: the symlink path
- name: callback
type: Function<Error>
type: Callback<Error>
summary: typical async callback function

- name: symlinkSync
Expand Down Expand Up @@ -939,7 +939,7 @@ methods:
default: 0
summary: target length to truncate to
- name: callback
type: Function<Error>
type: Callback<Error>
summary: typical async callback function

- name: truncateSync
Expand All @@ -964,7 +964,7 @@ methods:
type: [ String, buffer.Buffer ]
summary: file path
- name: callback
type: Function<Error>
type: Callback<Error>
summary: typical async callback function

- name: unlinkSync
Expand Down Expand Up @@ -1006,7 +1006,7 @@ methods:
type: [ Number, String, Date ]
summary: modification time
- name: callback
type: Function<Error>
type: Callback<Error>
summary: typical async callback function

- name: utimesSync
Expand Down Expand Up @@ -1083,7 +1083,7 @@ methods:
summary: offset from the beginning of the file where this data should be written (if data to be written is a `Buffer`)
optional: true
- name: callback
type: Function<Error>
type: Callback<Error>
summary: typical async callback function

- name: writeFile
Expand All @@ -1105,7 +1105,7 @@ methods:
summary: from the beginning of the file where this data should be written
optional: true
- name: callback
type: Function<Error>
type: Callback<Error>
summary: typical async callback function

- name: writeFileSync
Expand Down Expand Up @@ -1753,3 +1753,66 @@ summary: |
Instances of `fs.ReadStream` are created and returned using the `fs.createReadStream()` function.

**NOTE:** Titanium defines an empty class for this type. No methods/properties are implemented!

---
name: fs.StatsResponse
since: '8.3.0'
summary: Argument passed to the fs.Stats callback functions
properties:
- name: error
type: Error
summary: The error if one occurred
- name: stats
type: fs.Stats
summary: The fs.Stats object

---
name: fs.StringResponse
since: '8.3.0'
summary: Argument passed to callback functions expecting a string result
properties:
- name: error
type: Error
summary: The error if one occurred
- name: path
type: String
summary: The string result (typically a path)

---
name: fs.NumberResponse
since: '8.3.0'
summary: Argument passed to callback functions expecting a number result
properties:
- name: error
type: Error
summary: The error if one occurred
- name: fd
type: Number
summary: The file descriptor

---
name: fs.ReadResponse
since: '8.3.0'
summary: Argument passed to the read callback function
properties:
- name: error
type: Error
summary: The error if one occurred
- name: bytesRead
type: Number
summary: Number of bytes read
- name: buffer
type: buffer.Buffer
summary: The buffer that was read into

---
name: fs.ArrayResponse
since: '8.3.0'
summary: Argument passed to callback functions expecting an array result
properties:
- name: error
type: Error
summary: The error if one occurred
- name: files
type: Array<String>
summary: Array of file names
5 changes: 5 additions & 0 deletions apidoc/Titanium/Android/Android.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2585,3 +2585,8 @@ properties:
name: RequestPermissionAccessResult
summary: Argument passed to the callback when a request finishes successfully or erroneously.
extends: ErrorResponse

---
name: Promise<RequestPermissionAccessResult>
summary: A Promise that resolves to a RequestPermissionAccessResult
extends: Promise
5 changes: 5 additions & 0 deletions apidoc/Titanium/Blob.yml
Original file line number Diff line number Diff line change
Expand Up @@ -303,3 +303,8 @@ methods:
returns:
type: Promise<ArrayBuffer>
summary: Returns a `Promise` that resolves with the contents of the blob as binary data contained in an `ArrayBuffer`.

---
name: Promise<ArrayBuffer>
summary: A Promise that resolves to an ArrayBuffer
extends: Promise
5 changes: 5 additions & 0 deletions apidoc/Titanium/Calendar/Calendar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1152,3 +1152,8 @@ properties:
summary: Error code, if any returned.
description: May be undefined if `success` is `true`.
type: Number

---
name: Promise<EventsAuthorizationResponse>
summary: A Promise that resolves to an EventsAuthorizationResponse
extends: Promise
5 changes: 5 additions & 0 deletions apidoc/Titanium/Contacts/Contacts.yml
Original file line number Diff line number Diff line change
Expand Up @@ -517,3 +517,8 @@ properties:
name: ContactsAuthorizationResponse
summary: Argument passed to the callback when a request finishes successfully or erroneously.
extends: ErrorResponse

---
name: Promise<ContactsAuthorizationResponse>
summary: A Promise that resolves to a ContactsAuthorizationResponse
extends: Promise
10 changes: 10 additions & 0 deletions apidoc/Titanium/Database/DB.yml
Original file line number Diff line number Diff line change
Expand Up @@ -183,3 +183,13 @@ properties:
summary: Index of the failed query
type: Number
since: { android: "8.1.0", iphone: "8.1.0", ipad: "8.1.0" }

---
name: Promise<Titanium.Database.ResultSet>
summary: A Promise that resolves to a Titanium.Database.ResultSet
extends: Promise

---
name: Promise<Array<Titanium.Database.ResultSet>>
summary: A Promise that resolves to an array of Titanium.Database.ResultSet
extends: Promise
Loading
Loading