@data-client/rest/ts4.0/pathTypes.d.ts

Quickly define typed REST resources and endpoints

/** Computes the union of keys for a path string */
export declare type PathKeys<S extends string> = string;

/** Parameters for a given path */
export declare type PathArgs<S extends string> = PathKeys<S> extends never
  ? unknown
  : KeysToArgs<PathKeys<S>>;

/** Like PathArgs but widened `path: string` collapses to `unknown` */
export declare type SoftPathArgs<P extends string> =
  unknown extends P ? any
  : string extends P ? unknown
  : PathArgs<P>;

export declare type KeysToArgs<Key extends string> = {
  [K in Key]?: string | number;
};
export declare type PathArgsAndSearch<S extends string> =
  PathKeys<S> extends never
    ? Record<string, number | string | boolean> | undefined
    : {
        [K in PathKeys<S>]: string | number;
      } & Record<string, number | string>;

/** Removes the last :token */
export declare type ShortenPath<S extends string> = S;

export declare type ResourcePath = string;