UNPKG

1.38 kBTypeScriptView Raw
1/**
2 * @license
3 * Copyright 2019 Google LLC
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17import { Reference } from './reference';
18/**
19 * Result returned by `list()`.
20 * @public
21 */
22export interface ListResult {
23 /**
24 * References to prefixes (sub-folders). You can call list() on them to
25 * get its contents.
26 *
27 * Folders are implicit based on '/' in the object paths.
28 * For example, if a bucket has two objects '/a/b/1' and '/a/b/2', list('/a')
29 * will return '/a/b' as a prefix.
30 */
31 prefixes: Reference[];
32 /**
33 * Objects in this directory.
34 * You can call getMetadata() and getDownloadUrl() on them.
35 */
36 items: Reference[];
37 /**
38 * If set, there might be more results for this list. Use this token to resume the list.
39 */
40 nextPageToken?: string;
41}