> ISPO SDK documentation. [HTML](https://ispo.ai/docs/interfaces/core.SharedFileApi.html) · [Documentation index](https://ispo.ai/docs/llms.txt)

# Interface SharedFileApi

#### <a id="deprecated"></a>Deprecated

Shared path storage is retained only for legacy importers.

```typescript
interface SharedFileApi {
    list(path?: string): Promise<string[]>;
    put(
        content: string | Uint8Array<ArrayBufferLike>,
        options?: { name?: string },
    ): Promise<SharedPutResult>;
    read(path: string): Promise<string>;
    write(path: string, content: string): Promise<SharedWriteResult>;
    writeBinary(path: string, content: Uint8Array): Promise<SharedWriteResult>;
}
```

Types: [list](#list-1), [put](#put-1), [SharedPutResult](core.SharedPutResult.md), [read](#read-1), [write](#write-1), [SharedWriteResult](core.SharedWriteResult.md), [writeBinary](#writebinary-1)

##### Index

### <a id="methods"></a>Methods

[list](#list) [put](#put) [read](#read) [write](#write) [writeBinary](#writebinary)

## <a id="methods-1"></a>Methods

### <a id="list"></a>list

*   <a id="list-1"></a>
    
    ```typescript
    list(path?: string): Promise<string[]>
    ```
    
    #### Parameters
    
    *   `Optional`path: string
    
    #### Returns Promise<string\[\]\>
    

### <a id="put"></a>put

*   <a id="put-1"></a>
    
    ```typescript
    put(
        content: string | Uint8Array<ArrayBufferLike>,
        options?: { name?: string },
    ): Promise<SharedPutResult>
    ```
    
    Types: [SharedPutResult](core.SharedPutResult.md)
    
    #### Parameters
    
    *   content: string | Uint8Array<ArrayBufferLike\>
    *   `Optional`options: { name?: string }
    
    #### Returns Promise<[SharedPutResult](core.SharedPutResult.md)\>
    

### <a id="read"></a>read

*   <a id="read-1"></a>
    
    ```typescript
    read(path: string): Promise<string>
    ```
    
    #### Parameters
    
    *   path: string
    
    #### Returns Promise<string\>
    

### <a id="write"></a>write

*   <a id="write-1"></a>
    
    ```typescript
    write(path: string, content: string): Promise<SharedWriteResult>
    ```
    
    Types: [SharedWriteResult](core.SharedWriteResult.md)
    
    #### Parameters
    
    *   path: string
    *   content: string
    
    #### Returns Promise<[SharedWriteResult](core.SharedWriteResult.md)\>
    

### <a id="writebinary"></a>writeBinary

*   <a id="writebinary-1"></a>
    
    ```typescript
    writeBinary(path: string, content: Uint8Array): Promise<SharedWriteResult>
    ```
    
    Types: [SharedWriteResult](core.SharedWriteResult.md)
    
    #### Parameters
    
    *   path: string
    *   content: Uint8Array
    
    #### Returns Promise<[SharedWriteResult](core.SharedWriteResult.md)\>