Browse Source

docs(asset-server-plugin): Improve example code

Michael Bromley 3 years ago
parent
commit
d7f5c50772
1 changed files with 10 additions and 0 deletions
  1. 10 0
      packages/asset-server-plugin/src/s3-asset-storage-strategy.ts

+ 10 - 0
packages/asset-server-plugin/src/s3-asset-storage-strategy.ts

@@ -66,6 +66,11 @@ export interface S3Config {
  *
  * @example
  * ```TypeScript
+ * import { AssetServerPlugin, configureS3AssetStorage } from '\@vendure/asset-server-plugin';
+ * import { DefaultAssetNamingStrategy } from '\@vendure/core';
+ *
+ * // ...
+ *
  * plugins: [
  *   AssetServerPlugin.init({
  *     route: 'assets',
@@ -88,6 +93,11 @@ export interface S3Config {
  *
  * @example
  * ```TypeScript
+ * import { AssetServerPlugin, configureS3AssetStorage } from '\@vendure/asset-server-plugin';
+ * import { DefaultAssetNamingStrategy } from '\@vendure/core';
+ *
+ * // ...
+ *
  * plugins: [
  *   AssetServerPlugin.init({
  *     route: 'assets',