From 32411f659fa42649433bc01dcb81e454417ac306 Mon Sep 17 00:00:00 2001 From: mshanemc Date: Tue, 2 Apr 2024 10:15:58 -0500 Subject: [PATCH] chore: remove EXPORTED since we generate docs --- EXPORTED.md | 50 -------------------------------------------------- 1 file changed, 50 deletions(-) delete mode 100644 EXPORTED.md diff --git a/EXPORTED.md b/EXPORTED.md deleted file mode 100644 index 67391c4bfa..0000000000 --- a/EXPORTED.md +++ /dev/null @@ -1,50 +0,0 @@ -# Salesforce DX Core Library - -This library provides client-side management of Salesforce DX projects, org authentication, connections to Salesforce APIs, and various other utilities. These libraries are used by and follow patterns of the [Salesforce CLI](https://developer.salesforce.com/tools/sfdxcli). - -Requires [Node.js](https://nodejs.org) v8.4 or greater and [TypeScript](http://www.typescriptlang.org/) target `es2017`. - -## [AuthInfo]{@link AuthInfo} - -Create, read, update, and delete authentication information for an org. - -## [Connection]{@link Connection} - -Create an instance of an API connection to a Salesforce org. - -## {@link Org} - -Create a representation of an org based on an already authenticated alias, username, or default. The representation has a [connection]{@link Connection} and other useful methods for interacting with an org and its users. - -## [StreamingClient]{@link StreamingClient} - -Create an instance of a streaming API connection to a Salesforce org for a particular streaming channel. - -## {@link ConfigFile} - -Represents a config file at either a local or global path. The config file extends the {@link ConfigStore} which provides map-like functions to interact with config values. The following classes are config files. - -- {@link Aliases} -- {@link OrgUsersConfig} -- {@link Config} -- {@link SfProjectJson} - -## {@link ConfigAggregator} - -Aggregates local, global, and environment config values using {@link Config} and environment variables. - -## {@link SfProject} - -Represents a Salesforce DX project, defined by the file `sfdx-project.json`. - -## {@link Logger} - -All logging in `sfdx-core` is accomplished through this logging class. Anyone can also use the logger to log their own log lines to the `sfdx.log` file or to any other log file or stream by utilizing the log level flags and envars set by the CLI or framework. - -## [SfError]{@link SfError} - -An error class that is always thrown from `sfdx-core`, providing useful formatting and contextual data. - -## [Messages]{@link Messages} - -Manage user messages that are accessible by all plugins and consumers of `sfdx-core`.