/*
 * Copyright 2020 Spotify AB
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { ReaderOutput } from '../types';

export type LocationSource = {
  /**
   * Reads the contents of a single location.
   *
   * @param target The location target to read
   * @returns The parsed contents, as an array of unverified descriptors
   * @throws An error if the location target could not be read
   */
  read(target: string): Promise<ReaderOutput[]>;
};
