openharmony/interface_sdk-js
1
0
Fork 0
mirror of https://gitee.com/openharmony/interface_sdk-js synced 2024-11-23 07:10:52 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

!12443 Rectify d.ts scan problems

Browse Source 
Merge pull request !12443 from liyaoyao/master
This commit is contained in:
openharmony_ci 2024-07-15 02:07:32 +00:00 committed by Gitee
commit f74276e6e1
No known key found for this signature in database
GPG Key ID: 173E9B9CA92EEF8F
4 changed files with 60 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
api/@ohos.vibrator.d.ts vendored
View File

@ -431,6 +431,7 @@ declare namespace vibrator {
/**
* Vibrator id, default is 0.
*
* @type { ?number }
* @syscap SystemCapability.Sensors.MiscDevice
* @atomicservice
* @since 11
@ -446,6 +447,7 @@ declare namespace vibrator {
/**
* The use of vibration.
*
* @type { Usage }
* @syscap SystemCapability.Sensors.MiscDevice
* @atomicservice
* @since 11
@ -502,6 +504,7 @@ declare namespace vibrator {
/**
* The value is "time", which triggers the motor vibration according to the specified duration.
*
* @type { 'time' }
* @syscap SystemCapability.Sensors.MiscDevice
* @atomicservice
* @since 11
@ -517,6 +520,7 @@ declare namespace vibrator {
/**
* The duration of the vibration, in ms.
*
* @type { number }
* @syscap SystemCapability.Sensors.MiscDevice
* @atomicservice
* @since 11
@ -535,6 +539,7 @@ declare namespace vibrator {
/**
* The value is "preset", which triggers motor vibration according to preset vibration effect.
*
* @type { 'preset' }
* @syscap SystemCapability.Sensors.MiscDevice
* @since 9
*/
@ -543,6 +548,7 @@ declare namespace vibrator {
/**
* Preset type vibration.
*
* @type { string }
* @syscap SystemCapability.Sensors.MiscDevice
* @since 9
*/
@ -584,6 +590,7 @@ declare namespace vibrator {
/**
* The value is "file", which triggers motor vibration according to the vibration profile.
*
* @type { 'file' }
* @syscap SystemCapability.Sensors.MiscDevice
* @since 10
*/
@ -592,6 +599,7 @@ declare namespace vibrator {
/**
* Haptic file descriptor, some formats are supported.
*
* @type { HapticFileDescriptor }
* @syscap SystemCapability.Sensors.MiscDevice
* @since 10
*/
@ -611,6 +619,7 @@ declare namespace vibrator {
* The file descriptor of haptic effect source from file system. The caller
* is responsible to close the file descriptor.
*
* @type { number }
* @syscap SystemCapability.Sensors.MiscDevice
* @since 10
*/
@ -620,6 +629,7 @@ declare namespace vibrator {
* The offset into the file where the data to be read, in bytes. By default,
* the offset is zero.
*
* @type { ?number }
* @syscap SystemCapability.Sensors.MiscDevice
* @since 10
*/
@ -629,6 +639,7 @@ declare namespace vibrator {
* The length in bytes of the data to be read. By default, the length is the
* rest of bytes in the file from the offset.
*
* @type { ?number }
* @syscap SystemCapability.Sensors.MiscDevice
* @since 10
*/

46
api/@system.sensor.d.ts vendored
View File

@ -31,6 +31,7 @@ export interface AccelerometerResponse {
* X-coordinate
*
* @permission ohos.permission.ACCELEROMETER
* @type { number }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 3
* @deprecated since 8
@ -41,6 +42,7 @@ export interface AccelerometerResponse {
* Y-coordinate
*
* @permission ohos.permission.ACCELEROMETER
* @type { number }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 3
* @deprecated since 8
@ -51,6 +53,7 @@ export interface AccelerometerResponse {
* Z-coordinate
*
* @permission ohos.permission.ACCELEROMETER
* @type { number }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 3
* @deprecated since 8
@ -76,6 +79,7 @@ export interface subscribeAccelerometerOptions {
* The default value is normal.
*
* @permission ohos.permission.ACCELEROMETER
* @type { string }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 3
* @deprecated since 8
@ -86,6 +90,7 @@ export interface subscribeAccelerometerOptions {
* Called when acceleration sensor data changes.
*
* @permission ohos.permission.ACCELEROMETER
* @type { function }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 3
* @deprecated since 8
@ -96,6 +101,7 @@ export interface subscribeAccelerometerOptions {
* Called when the listening fails.
*
* @permission ohos.permission.ACCELEROMETER
* @type { ?function }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 3
* @deprecated since 8
@ -114,6 +120,7 @@ export interface CompassResponse {
/**
* Direction of the device (in degrees).
*
* @type { number }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 3
* @deprecated since 8
@ -132,6 +139,7 @@ export interface SubscribeCompassOptions {
/**
* Called when compass sensor data changes.
*
* @type { function }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 3
* @deprecated since 8
@ -141,6 +149,7 @@ export interface SubscribeCompassOptions {
/**
* Called when the listening fails.
*
* @type { ?function }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 3
* @deprecated since 8
@ -159,6 +168,7 @@ export interface ProximityResponse {
/**
* Distance between a visible object and the device screen
*
* @type { number }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 3
* @deprecated since 8
@ -176,7 +186,8 @@ export interface ProximityResponse {
export interface SubscribeProximityOptions {
/**
* Called when distance sensor data changes.
* *
*
* @type { function }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 3
* @deprecated since 8
@ -185,7 +196,8 @@ export interface SubscribeProximityOptions {
/**
* Called when the listening fails.
* *
*
* @type { ?function }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 3
* @deprecated since 8
@ -204,6 +216,7 @@ export interface LightResponse {
/**
* Light intensity, in lux.
*
* @type { number }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 3
* @deprecated since 8
@ -222,6 +235,7 @@ export interface SubscribeLightOptions {
/**
* Called when ambient light sensor data changes.
*
* @type { function }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 3
* @deprecated since 8
@ -231,6 +245,7 @@ export interface SubscribeLightOptions {
/**
* Called when the listening fails.
*
* @type { ?function }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 3
* @deprecated since 8
@ -252,6 +267,7 @@ export interface StepCounterResponse {
* Each time the device restarts, the value is recalculated from 0 in phone, tablet.
*
* @permission ohos.permission.ACTIVITY_MOTION
* @type { number }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 3
* @deprecated since 8
@ -272,6 +288,7 @@ export interface SubscribeStepCounterOptions {
* Called when step counter sensor data changes.
*
* @permission ohos.permission.ACTIVITY_MOTION
* @type { function }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 3
* @deprecated since 8
@ -282,6 +299,7 @@ export interface SubscribeStepCounterOptions {
* Called when the listening fails.
*
* @permission ohos.permission.ACTIVITY_MOTION
* @type { ?function }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 3
* @deprecated since 8
@ -300,6 +318,7 @@ export interface BarometerResponse {
/**
* Pressure, in hpa.
*
* @type { number }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 3
* @deprecated since 8
@ -318,6 +337,7 @@ export interface SubscribeBarometerOptions {
/**
* Called when the barometer sensor data changes.
*
* @type { function }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 3
* @deprecated since 8
@ -327,6 +347,7 @@ export interface SubscribeBarometerOptions {
/**
* Called when the listening fails.
*
* @type { ?function }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 3
* @deprecated since 8
@ -348,6 +369,7 @@ export interface HeartRateResponse {
* 255 indicates an invalid value in lite wearable.
*
* @permission ohos.permission.READ_HEALTH_DATA
* @type { number }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 3
* @deprecated since 8
@ -368,6 +390,7 @@ export interface SubscribeHeartRateOptions {
* Called when the heart rate sensor data changes.
*
* @permission ohos.permission.READ_HEALTH_DATA
* @type { function }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 3
* @deprecated since 8
@ -378,6 +401,7 @@ export interface SubscribeHeartRateOptions {
* Called when the listening fails
*
* @permission ohos.permission.READ_HEALTH_DATA
* @type { ?function }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 3
* @deprecated since 8
@ -396,6 +420,7 @@ export interface OnBodyStateResponse {
/**
* Whether the sensor is worn.
*
* @type { boolean }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 3
* @deprecated since 8
@ -414,6 +439,7 @@ export interface SubscribeOnBodyStateOptions {
/**
* Called when the wearing status changes.
*
* @type { function }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 3
* @deprecated since 8
@ -423,6 +449,7 @@ export interface SubscribeOnBodyStateOptions {
/**
* Called when the listening fails.
*
* @type { ?function }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 3
* @deprecated since 8
@ -441,6 +468,7 @@ export interface GetOnBodyStateOptions {
/**
* Called when the sensor wearing state is obtained
*
* @type { function }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 3
* @deprecated since 8
@ -450,6 +478,7 @@ export interface GetOnBodyStateOptions {
/**
* Called when the sensor wearing state fails to be obtained
*
* @type { ?function }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 3
* @deprecated since 8
@ -459,6 +488,7 @@ export interface GetOnBodyStateOptions {
/**
* Called when the execution is completed
*
* @type { ?function }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 3
* @deprecated since 8
@ -477,6 +507,7 @@ export interface DeviceOrientationResponse {
/**
* alpha
*
* @type { number }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 6
* @deprecated since 8
@ -486,6 +517,7 @@ export interface DeviceOrientationResponse {
/**
* beta
*
* @type { number }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 6
* @deprecated since 8
@ -495,6 +527,7 @@ export interface DeviceOrientationResponse {
/**
* gamma
*
* @type { number }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 6
* @deprecated since 8
@ -518,6 +551,7 @@ export interface SubscribeDeviceOrientationOptions {
* 3. normal: Regular frequency (200 ms per callback), which is application to low power consumption.
* The default value is normal.
*
* @type { string }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 6
* @deprecated since 8
@ -527,6 +561,7 @@ export interface SubscribeDeviceOrientationOptions {
/**
* Called when device orientation sensor data changes.
*
* @type { function}
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 6
* @deprecated since 8
@ -536,6 +571,7 @@ export interface SubscribeDeviceOrientationOptions {
/**
* Called when the listening fails.
*
* @type { ?function }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 6
* @deprecated since 8
@ -556,6 +592,7 @@ export interface GyroscopeResponse {
* X-coordinate
*
* @permission ohos.permission.GYROSCOPE
* @type { number }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 6
* @deprecated since 8
@ -566,6 +603,7 @@ export interface GyroscopeResponse {
* Y-coordinate
*
* @permission ohos.permission.GYROSCOPE
* @type { number }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 6
* @deprecated since 8
@ -576,6 +614,7 @@ export interface GyroscopeResponse {
* Z-coordinate
*
* @permission ohos.permission.GYROSCOPE
* @type { number }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 6
* @deprecated since 8
@ -601,6 +640,7 @@ export interface SubscribeGyroscopeOptions {
* The default value is normal.
*
* @permission ohos.permission.GYROSCOPE
* @type { string }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 6
* @deprecated since 8
@ -611,6 +651,7 @@ export interface SubscribeGyroscopeOptions {
* Called when gyroscope sensor data changes.
*
* @permission ohos.permission.GYROSCOPE
* @type { function }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 6
* @deprecated since 8
@ -621,6 +662,7 @@ export interface SubscribeGyroscopeOptions {
* Called when the listening fails.
*
* @permission ohos.permission.GYROSCOPE
* @type { ?function }
* @syscap SystemCapability.Sensors.Sensor.Lite
* @since 6
* @deprecated since 8

4
api/@system.vibrator.d.ts vendored
View File

@ -32,6 +32,7 @@ export interface VibrateOptions {
* The default value is long.
*
* @permission ohos.permission.VIBRATE
* @type { ?('long' | 'short') }
* @syscap SystemCapability.Sensors.MiscDevice.Lite
* @since 3
* @deprecated since 8
@ -42,6 +43,7 @@ export interface VibrateOptions {
* Called when success to trigger vibration.
*
* @permission ohos.permission.VIBRATE
* @type { function }
* @syscap SystemCapability.Sensors.MiscDevice.Lite
* @since 3
* @deprecated since 8
@ -52,6 +54,7 @@ export interface VibrateOptions {
* Called when fail to trigger vibration.
*
* @permission ohos.permission.VIBRATE
* @type { ?function }
* @syscap SystemCapability.Sensors.MiscDevice.Lite
* @since 3
* @deprecated since 8
@ -62,6 +65,7 @@ export interface VibrateOptions {
* Called when the execution is completed.
*
* @permission ohos.permission.VIBRATE
* @type { ?function }
* @syscap SystemCapability.Sensors.MiscDevice.Lite
* @since 3
* @deprecated since 8