mirror of
https://github.com/facebook/react-native.git
synced 2026-11-18 20:19:07 +00:00
Summary: There was a JSDoc mismatch in `Clipboard.setString` method, `the` was considered as a parameter name, not `content`. Added correct param name and kept the same description as before, separated with a hyphen. ## Changelog [GENERAL] [FIXED] - Fixes JSDoc in Cliapboard setString Pull Request resolved: https://github.com/facebook/react-native/pull/36381 Test Plan: No tests needed Reviewed By: yungsters Differential Revision: D43839086 Pulled By: cortinico fbshipit-source-id: 126035d9796e66938402704eaf9bc8646ee9b78b
41 lines
1.1 KiB
JavaScript
41 lines
1.1 KiB
JavaScript
/**
|
|
* Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*
|
|
* @format
|
|
* @flow strict
|
|
*/
|
|
|
|
import NativeClipboard from './NativeClipboard';
|
|
|
|
/**
|
|
* `Clipboard` gives you an interface for setting and getting content from Clipboard on both iOS and Android
|
|
*/
|
|
module.exports = {
|
|
/**
|
|
* Get content of string type, this method returns a `Promise`, so you can use following code to get clipboard content
|
|
* ```javascript
|
|
* async _getContent() {
|
|
* var content = await Clipboard.getString();
|
|
* }
|
|
* ```
|
|
*/
|
|
getString(): Promise<string> {
|
|
return NativeClipboard.getString();
|
|
},
|
|
/**
|
|
* Set content of string type. You can use following code to set clipboard content
|
|
* ```javascript
|
|
* _setContent() {
|
|
* Clipboard.setString('hello world');
|
|
* }
|
|
* ```
|
|
* @param {string} content the content to be stored in the clipboard.
|
|
*/
|
|
setString(content: string) {
|
|
NativeClipboard.setString(content);
|
|
},
|
|
};
|