Skip to content

add deprecated to listPrefixV2 #411

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 17, 2023
Merged

add deprecated to listPrefixV2 #411

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 12 additions & 1 deletion index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -775,10 +775,21 @@ export declare namespace rs {
*
* @param bucket 空间名称
* @param options 列举操作的可选参数
* @param callback
* @param callback 回调函数
*/
listPrefix(bucket: string, options: ListPrefixOptions | null, callback: callback): void;

/**
* 获取制定前缀的文件列表 V2
*
* @deprecated API 可能返回仅包含 marker，不包含 item 或 dir 的项，请使用 {@link listPrefix}
*
* @param bucket 空间名称
* @param options 列举操作的可选参数
* @param callback 回调函数
*/
listPrefixV2(bucket: string, options: ListPrefixOptions | null, callback: callback): void;

/**
* 批量文件管理请求，支持stat，chgm，chtype，delete，copy，move
* @param operations
Expand Down
64 changes: 35 additions & 29 deletions qiniu/storage/rs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -412,16 +412,18 @@ BucketManager.prototype.unimage = function (bucket, callbackFunc) {
rpc.postWithoutForm(requestURI, digest, callbackFunc);
};

// 获取指定前缀的文件列表
// @link https://developer.qiniu.com/kodo/api/1284/list
//
// @param bucket 空间名称
// @param options 列举操作的可选参数
// prefix 列举的文件前缀
// marker 上一次列举返回的位置标记，作为本次列举的起点信息
// limit 每次返回的最大列举文件数量
// delimiter 指定目录分隔符
// @param callbackFunc(err, respBody, respInfo) - 回调函数
/**
* 获取指定前缀的文件列表
* @link https://developer.qiniu.com/kodo/api/1284/list
*
* @param { string } bucket 空间名称
* @param { Object } options 列举操作的可选参数
* @param { string } options.prefix 列举的文件前缀
* @param { string } options.marker 上一次列举返回的位置标记，作为本次列举的起点信息
* @param { number } options.limit 每次返回的最大列举文件数量
* @param { string } options.delimiter 指定目录分隔符
* @param { function } callbackFunc(err, respBody, respInfo) 回调函数
*/
BucketManager.prototype.listPrefix = function (bucket, options, callbackFunc) {
util.prepareZone(this, this.mac.accessKey, bucket, function (err, ctx) {
if (err) {
Expand All @@ -432,10 +434,10 @@ BucketManager.prototype.listPrefix = function (bucket, options, callbackFunc) {
});
};

function listPrefixReq(mac, config, bucket, options, callbackFunc) {
function listPrefixReq (mac, config, bucket, options, callbackFunc) {
options = options || {};
// 必须参数
var reqParams = {
const reqParams = {
bucket: bucket
};

Expand Down Expand Up @@ -463,9 +465,9 @@ function listPrefixReq(mac, config, bucket, options, callbackFunc) {
reqParams.delimiter = '';
}

var scheme = config.useHttpsDomain ? 'https://' : 'http://';
var reqSpec = querystring.stringify(reqParams);
var requestURI = scheme + config.zone.rsfHost + '/list?' + reqSpec;
const scheme = config.useHttpsDomain ? 'https://' : 'http://';
const reqSpec = querystring.stringify(reqParams);
const requestURI = scheme + config.zone.rsfHost + '/list?' + reqSpec;

rpc.postWithOptions(
requestURI,
Expand All @@ -477,15 +479,19 @@ function listPrefixReq(mac, config, bucket, options, callbackFunc) {
);
}

// 获取指定前缀的文件列表
//
// @param bucket 空间名称
// @param options 列举操作的可选参数
// prefix 列举的文件前缀
// marker 上一次列举返回的位置标记，作为本次列举的起点信息
// limit 每次返回的最大列举文件数量
// delimiter 指定目录分隔符
// @param callbackFunc(err, respBody, respInfo) - 回调函数
/**
* 获取指定前缀的文件列表 V2
*
* @deprecated API 可能返回仅包含 marker，不包含 item 或 dir 的项，请使用 {@link listPrefix}
*
* @param bucket 空间名称
* @param { Object } options 列举操作的可选参数
* @param { string } options.prefix 列举的文件前缀
* @param { string } options.marker 上一次列举返回的位置标记，作为本次列举的起点信息
* @param { number } options.limit 每次返回的最大列举文件数量
* @param { string } options.delimiter 指定目录分隔符
* @param { function } callbackFunc(err, respBody, respInfo) 回调函数
*/
BucketManager.prototype.listPrefixV2 = function (bucket, options, callbackFunc) {
util.prepareZone(this, this.mac.accessKey, bucket, function (err, ctx) {
if (err) {
Expand All @@ -496,10 +502,10 @@ BucketManager.prototype.listPrefixV2 = function (bucket, options, callbackFunc)
});
};

function listPrefixReqV2(mac, config, bucket, options, callbackFunc) {
function listPrefixReqV2 (mac, config, bucket, options, callbackFunc) {
options = options || {};
// 必须参数
var reqParams = {
const reqParams = {
bucket: bucket
};

Expand Down Expand Up @@ -527,9 +533,9 @@ function listPrefixReqV2(mac, config, bucket, options, callbackFunc) {
reqParams.delimiter = '';
}

var scheme = config.useHttpsDomain ? 'https://' : 'http://';
var reqSpec = querystring.stringify(reqParams);
var requestURI = scheme + config.zone.rsfHost + '/v2/list?' + reqSpec;
const scheme = config.useHttpsDomain ? 'https://' : 'http://';
const reqSpec = querystring.stringify(reqParams);
const requestURI = scheme + config.zone.rsfHost + '/v2/list?' + reqSpec;

rpc.postWithOptions(
requestURI,
Expand Down