*** title: "AssetService" generated: true --------------- ## AssetService Contains methods relating to [Asset](/current/core/reference/typescript-api/entities/asset#asset) entities. ```ts title="Signature" class AssetService { constructor(connection: TransactionalConnection, configService: ConfigService, listQueryBuilder: ListQueryBuilder, eventBus: EventBus, tagService: TagService, channelService: ChannelService, roleService: RoleService, customFieldRelationService: CustomFieldRelationService, translatableSaver: TranslatableSaver, translator: TranslatorService) findOne(ctx: RequestContext, id: ID, relations?: RelationPaths) => Promise | undefined>; findAll(ctx: RequestContext, options?: AssetListOptions, relations?: RelationPaths) => Promise>>; getFeaturedAsset(ctx: RequestContext, entity: T) => Promise; getEntityAssets(ctx: RequestContext, entity: T) => Promise; updateFeaturedAsset(ctx: RequestContext, entity: T, input: EntityAssetInput) => Promise; updateEntityAssets(ctx: RequestContext, entity: T, input: EntityAssetInput) => Promise; create(ctx: RequestContext, input: CreateAssetInput) => Promise | MimeTypeError>; update(ctx: RequestContext, input: UpdateAssetInput) => Promise>; delete(ctx: RequestContext, ids: ID[], force: boolean = false, deleteFromAllChannels: boolean = false) => Promise; assignToChannel(ctx: RequestContext, input: AssignAssetsToChannelInput) => Promise>>; createFromFileStream(stream: ReadStream, ctx?: RequestContext) => Promise | MimeTypeError>; createFromFileStream(stream: Readable, filePath: string, ctx?: RequestContext) => Promise | MimeTypeError>; createFromFileStream(stream: ReadStream | Readable, maybeFilePathOrCtx?: string | RequestContext, maybeCtx?: RequestContext) => Promise | MimeTypeError>; } ```

### findOne \RequestContext, id: ID, relations?: RelationPaths<Asset>) => PromiseAsset> | undefined>`} /> ### findAll \RequestContext, options?: AssetListOptions, relations?: RelationPaths<Asset>) => Promise<PaginatedListAsset>>>`} /> ### getFeaturedAsset \RequestContext, entity: T) => Promise<Asset | undefined>`} /> ### getEntityAssets \RequestContext, entity: T) => Promise<Asset[] | undefined>`} /> Returns the Assets of an entity which has a well-ordered list of Assets, such as Product, ProductVariant or Collection. ### updateFeaturedAsset \RequestContext, entity: T, input: EntityAssetInput) => Promise`} /> ### updateEntityAssets \RequestContext, entity: T, input: EntityAssetInput) => Promise`} /> Updates the assets / featuredAsset of an entity, ensuring that only valid assetIds are used. ### create \RequestContext, input: CreateAssetInput) => PromiseAsset> | MimeTypeError>`} /> Create an Asset based on a file uploaded via the GraphQL API. The file should be uploaded using the [GraphQL multipart request specification](https://github.com/jaydenseric/graphql-multipart-request-spec), e.g. using the [apollo-upload-client](https://github.com/jaydenseric/apollo-upload-client) npm package. See the [Uploading Files docs](/current/core/developer-guide/uploading-files) for an example of usage. ### update \RequestContext, input: UpdateAssetInput) => PromiseAsset>>`} /> Updates the name, focalPoint, tags & custom fields of an Asset. ### delete \RequestContext, ids: ID[], force: boolean = false, deleteFromAllChannels: boolean = false) => Promise`} /> Deletes an Asset after performing checks to ensure that the Asset is not currently in use by a Product, ProductVariant or Collection. ### assignToChannel \RequestContext, input: AssignAssetsToChannelInput) => PromiseAsset>>>`} /> ### createFromFileStream \RequestContext) => PromiseAsset> | MimeTypeError>`} /> Create an Asset from a file stream, for example to create an Asset during data import. ### createFromFileStream \RequestContext) => PromiseAsset> | MimeTypeError>`} /> ### createFromFileStream \RequestContext, maybeCtx?: RequestContext) => PromiseAsset> | MimeTypeError>`} />

## EntityWithAssets Certain entities (Product, ProductVariant, Collection) use this interface to model a featured asset and then a list of assets with a defined order. ```ts title="Signature" interface EntityWithAssets extends VendureEntity { featuredAsset: Asset | null; assets: OrderableAsset[]; } ``` * Extends: [`VendureEntity`](/current/core/reference/typescript-api/entities/vendure-entity#vendureentity)

### featuredAsset \Asset | null`} /> ### assets \OrderableAsset[]`} />

## EntityAssetInput Used when updating entities which implement [EntityWithAssets](/current/core/reference/typescript-api/services/asset-service#entitywithassets). ```ts title="Signature" interface EntityAssetInput { assetIds?: ID[] | null; featuredAssetId?: ID | null; } ```

### assetIds \ID[] | null`} /> ### featuredAssetId \ID | null`} />